Create an external job.

post

https://api.test.bluestonepim.com/async-operations/jobs/external-job

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalId

string

required

Custom id for external job. Together with type and organization - it is making unique constraint.

type

string

required

Identifier for the type of a job. Should be shared between jobs of the same type.

typeDescription

string

required

User friendly name for a type. Should be shared between jobs of the same type (avoid using 'Sync 20 products' and anything else that would make name dynamic).

status

string

enum

required

Status of a job to be presented in UI.

Allowed:

initiator

InitiatorService | InitiatorUser | InitiatorApiClient

required

User, service or api client that started the job.

additionalFields

array of objects

Additional fields, can be used to present informations in the UI, or just store information if used with hidden option.

additionalFields

assets

array of objects

Assets reference to a job - please use contain willContainAssets if your job is meant to have assets at one point.

assets

files

array of objects

Files references to job - please use contain willContainFiles if your job is meant to have files at one point. Connected links should be public.

files

connectedEntities

array of objects

Entities reference connected to a job. Can be updated only on job creation. Should not contain more than 1000 ids.

connectedEntities

errors

array of objects

Errors connected to a job.

errors

contexts

array of strings

Context id of a job.

contexts

progress

double

Numerical (0-100) progress meter for a job.

willContainAssets

boolean

Helper property used by UI to know that job will have connected assets at one point.

willContainFiles

boolean

Helper property used by UI to know that job will have connected files at one point.

Responses

201

Success

409

Duplicated

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here!