{"items":[{"type":"link","label":"Jobs API","link":"/ch/jobs-api","routeSlug":"/ch/jobs-api","content":{"contentType":"overview","meta":{"name":"Jobs API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/ch/jobs-api/@v2.0/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/ch/jobs-api/@v2.0/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"closed source","url":"https://www.sitecore.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Jobs API (v2.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Jobs API to retrieve, create, update, and delete job targets or the description."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This REST API lets you interact with:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M.Target"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entities, which are targets of a job."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M.JobDescription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entity, which contains information about what to do and what is in progress."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To help you switch to the Jobs API, we provide "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/switch-to-the-jobs-api.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guidance on how to update calls in your code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]}]}],"sectionId":"/ch/jobs-api"}],"sectionId":"/ch/jobs-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the Jobs API, you need:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of your Content Hub server. You can get this from your Content Hub Administrator. Enter this URL in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{{server}}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variable by hovering your mouse over the variable in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pane and then clicking "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#making-requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access token and the client ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Both are sent with every request. You can create a token through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Hub interface"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  or by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#making-requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requesting one using the API itself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"sectionId":"/ch/jobs-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/ch/jobs-api/section/authentication","routeSlug":"/ch/jobs-api/section/authentication","content":null},{"type":"group","label":"Jobs","link":"/ch/jobs-api/jobs","routeSlug":"/ch/jobs-api/jobs","items":[{"label":"Retrieve a job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/jobs/jobbyidv2","routeSlug":"/ch/jobs-api/jobs/jobbyidv2","metadata":{"seo":{"title":"Retrieve a job","description":"Retrieves a job with a specified ID. Job targets are not retrieved. Only the link to the relation is used. You can get the job ID in the Job details or in the URL when you click a job target on the Processing page (for example, https://contenthub-server.cloud/en-us/user/myjobs/Job/39309 )."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"JobByIdV2","name":"Retrieve a job","isWebhook":false,"pointer":"/paths/~1api~1v2~1jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a job with a specified ID. Job targets are not retrieved. Only the link to the relation is used. You can get the job ID in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/users/content-hub/job-details.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or in the URL when you click a job target on the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://contenthub-server.cloud/en-us/user/myjobs/Job/39309"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" )."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v2~1jobs~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cultures","in":"query","schemaId":"schema_1399","description":"List of cultures in which to load the entity. If no cultures are provided, multi-language properties are not included."}],"pointer":"/paths/~1api~1v2~1jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/jobs/{id}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"}],"query":[{"name":"cultures","in":"query","schemaId":"schema_1399"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/v2/jobs/{id}","href":"jobs/jobbyidv2","openApiOperationId":"JobByIdV2","summary":"Retrieve a job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"schemaId":"components/schemas/EntityResource"},{"code":"400","description":"Request or Job ID not valid (for example, less than or equal to zero or does not exist), or at least one culture is null."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1v2~1jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityResource"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/jobbyidv2"}],"panels":[]}]},"httpPath":"/api/v2/jobs/{id}"}],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true},{"nodeType":"markdoc","content":"The Jobs endpoint is used to retrieve a specific job."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/jobs/{id}","summary":"Retrieve a job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/jobbyidv2","deprecated":false}]}]}]}]}},{"type":"group","label":"Job description","link":"/ch/jobs-api/job-description","routeSlug":"/ch/jobs-api/job-description","items":[{"label":"Retrieve the job description","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/job-description/jobdescription","routeSlug":"/ch/jobs-api/job-description/jobdescription","metadata":{"seo":{"title":"Retrieve the job description","description":"Retrieves the description for a specific job using its ID, for example 39595."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"JobDescription","name":"Retrieve the job description","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1description/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the job description","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the description for a specific job using its ID, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39595"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1description/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cultures","in":"query","schemaId":"schema_1399","description":"List of cultures in which to load the entity. If no cultures are provided, multi-language properties are not included."}],"pointer":"/paths/~1api~1jobs~1{id}~1description/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/jobs/{id}/description","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"}],"query":[{"name":"cultures","in":"query","schemaId":"schema_1399"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/jobs/{id}/description","href":"job-description/jobdescription","openApiOperationId":"JobDescription","summary":"Retrieve the job description"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"schemaId":"components/schemas/EntityResource"},{"code":"400","description":"Request not valid or error during operation."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1description/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityResource"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-description/jobdescription"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/description"},{"label":"Create or update the job description","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/job-description/createorupdatedescription","routeSlug":"/ch/jobs-api/job-description/createorupdatedescription","metadata":{"seo":{"title":"Create or update the job description","description":"Creates a job description entity if it does not exist or updates the job description entity. It confirms that the job exists and that the user has permission to access it. Properties or relations not included in the request will be set to null."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOrUpdateDescription","name":"Create or update the job description","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1description/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update the job description","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a job description entity if it does not exist or updates the job description entity. It confirms that the job exists and that the user has permission to access it. Properties or relations not included in the request will be set to null."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1description/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobDescriptionResource"}},"schemaId":"components/schemas/JobDescriptionResource","pointer":"/paths/~1api~1jobs~1{id}~1description/put/requestBody","description":"The request containing the job description information."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/jobs/{id}/description","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobDescriptionResource"}},"responseCodes":["201","204","400","401","404"],"pointer":"/api/jobs/{id}/description","href":"job-description/createorupdatedescription","openApiOperationId":"CreateOrUpdateDescription","summary":"Create or update the job description"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/JobDescriptionResource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobDescriptionResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Job description successfully created."},{"code":"204","description":"Job description successfully updated."},{"code":"400","description":"Request not valid or error during operation."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1description/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-description/createorupdatedescription"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/description"},{"label":"Partially update the job description","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/job-description/partialupdatedescription","routeSlug":"/ch/jobs-api/job-description/partialupdatedescription","metadata":{"seo":{"title":"Partially update the job description","description":"Updates part of the job description entity. It confirms that both the job and description exist and that the user has permission to modify them. Properties or relations not included in the request will be set to null."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PartialUpdateDescription","name":"Partially update the job description","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1description/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update the job description","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates part of the job description entity. It confirms that both the job and description exist and that the user has permission to modify them. Properties or relations not included in the request will be set to null."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1description/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"schemaId":"components/schemas/EntityResource","pointer":"/paths/~1api~1jobs~1{id}~1description/patch/requestBody","description":"The request containing the updated job description information."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/jobs/{id}/description","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"responseCodes":["204","400","401","404"],"pointer":"/api/jobs/{id}/description","href":"job-description/partialupdatedescription","openApiOperationId":"PartialUpdateDescription","summary":"Partially update the job description"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/EntityResource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Entity successfully updated."},{"code":"400","description":"Request not valid or error during operation."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1description/patch/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-description/partialupdatedescription"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/description"},{"label":"Delete the job description","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/job-description/deletedescription","routeSlug":"/ch/jobs-api/job-description/deletedescription","metadata":{"seo":{"title":"Delete the job description","description":"Deletes the description associated with a job. It confirms that both the job and description exist and that the user has permission to access them."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteDescription","name":"Delete the job description","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1description/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the job description","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the description associated with a job. It confirms that both the job and description exist and that the user has permission to access them."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1description/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/jobs/{id}/description","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","404"],"pointer":"/api/jobs/{id}/description","href":"job-description/deletedescription","openApiOperationId":"DeleteDescription","summary":"Delete the job description"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful deletion."},{"code":"400","description":"Request not valid or error during operation."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1description/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-description/deletedescription"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/description"},{"label":"Retrieve the job description","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/job-description/jobdescriptionbyid","routeSlug":"/ch/jobs-api/job-description/jobdescriptionbyid","metadata":{"seo":{"title":"Retrieve the job description","description":"Retrieves the description for a specific job using its ID, for example 39595."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"JobDescriptionById","name":"Retrieve the job description","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1description~1{descriptionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the job description","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the description for a specific job using its ID, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39595"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"descriptionId","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job description, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"98765"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1description~1{descriptionId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cultures","in":"query","schemaId":"schema_1399","description":"List of cultures in which to load the entity. If no cultures are provided, multi-language properties are not included."}],"pointer":"/paths/~1api~1jobs~1{id}~1description~1{descriptionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/jobs/{id}/description/{descriptionId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"},{"name":"descriptionId","in":"path","required":true,"schemaId":"schema_1398"}],"query":[{"name":"cultures","in":"query","schemaId":"schema_1399"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/jobs/{id}/description/{descriptionId}","href":"job-description/jobdescriptionbyid","openApiOperationId":"JobDescriptionById","summary":"Retrieve the job description"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"schemaId":"components/schemas/EntityResource"},{"code":"400","description":"Request not valid or error during operation."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1description~1{descriptionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityResource"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-description/jobdescriptionbyid"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/description/{descriptionId}"}],"content":{"contentType":"group","meta":{"name":"Job description"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Job description","showPageActions":true},{"nodeType":"markdoc","content":"The Job description entity contains information for the worker about what needs to be done and what is in progress."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/jobs/{id}/description","summary":"Retrieve the job description","prefix":{"name":"get","color":"get"},"badges":[],"link":"/job-description/jobdescription","deprecated":false},{"title":"/api/jobs/{id}/description","summary":"Create or update the job description","prefix":{"name":"put","color":"put"},"badges":[],"link":"/job-description/createorupdatedescription","deprecated":false},{"title":"/api/jobs/{id}/description","summary":"Partially update the job description","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/job-description/partialupdatedescription","deprecated":false},{"title":"/api/jobs/{id}/description","summary":"Delete the job description","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/job-description/deletedescription","deprecated":false},{"title":"/api/jobs/{id}/description/{descriptionId}","summary":"Retrieve the job description","prefix":{"name":"get","color":"get"},"badges":[],"link":"/job-description/jobdescriptionbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Targets","link":"/ch/jobs-api/targets","routeSlug":"/ch/jobs-api/targets","items":[{"label":"Create a job target","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/targets/createtarget","routeSlug":"/ch/jobs-api/targets/createtarget","metadata":{"seo":{"title":"Create a job target","description":"Creates a new target for the specified job and returns the job target ID, for example 39605."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateTarget","name":"Create a job target","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1targets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a job target","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new target for the specified job and returns the job target ID, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39605"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job target, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39605"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1targets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityPostResource"}},"schemaId":"components/schemas/EntityPostResource","pointer":"/paths/~1api~1jobs~1{id}~1targets/post/requestBody","description":"The request containing the target information."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/jobs/{id}/targets","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntityPostResource"}},"responseCodes":["201","400","401","404"],"pointer":"/api/jobs/{id}/targets","href":"targets/createtarget","openApiOperationId":"CreateTarget","summary":"Create a job target"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/EntityPostResource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityPostResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Target successfully created."},{"code":"400","description":"Request not valid (for example, less than or equal to zero), or target resource is null."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1targets/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/targets/createtarget"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/targets"},{"label":"Retrieve all job targets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/targets/jobtargets","routeSlug":"/ch/jobs-api/targets/jobtargets","metadata":{"seo":{"title":"Retrieve all job targets","description":"Lists all the targets associated with a job that match the criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"JobTargets","name":"Retrieve all job targets","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1targets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all job targets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all the targets associated with a job that match the criteria."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1targets/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"state","in":"query","schemaId":"schema_1400","description":"The state of the job targets.","example":"Completed"},{"name":"condition","in":"query","schemaId":"schema_1400","description":"The condition of the job targets.","example":"Pending"},{"name":"type","in":"query","schemaId":"schema_1400","description":"The type of the job targets.","example":"Import"},{"name":"location","in":"query","schemaId":"schema_1400","description":"The location of the targets. This is a full string match."},{"name":"skip","in":"query","schemaId":"schema_1401","description":"The number of items to skip."},{"name":"take","in":"query","schemaId":"schema_1402","description":"The number of items to take."},{"name":"cultures","in":"query","schemaId":"schema_1399","description":"List of cultures in which to load the entity. If no cultures are provided, multi-language properties are not included."}],"pointer":"/paths/~1api~1jobs~1{id}~1targets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/jobs/{id}/targets","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"}],"query":[{"name":"state","in":"query","example":"Completed","schemaId":"schema_1400"},{"name":"condition","in":"query","example":"Pending","schemaId":"schema_1400"},{"name":"type","in":"query","example":"Import","schemaId":"schema_1400"},{"name":"location","in":"query","schemaId":"schema_1400"},{"name":"skip","in":"query","schemaId":"schema_1401"},{"name":"take","in":"query","schemaId":"schema_1402"},{"name":"cultures","in":"query","schemaId":"schema_1399"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/jobs/{id}/targets","href":"targets/jobtargets","openApiOperationId":"JobTargets","summary":"Retrieve all job targets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityCollectionResource"}},"schemaId":"components/schemas/EntityCollectionResource"},{"code":"400","description":"Request or Job ID not valid (for example, less than or equal to zero or does not exist), or at least one culture is null."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1targets/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityCollectionResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityCollectionResource"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/targets/jobtargets"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/targets"},{"label":"Create multiple job targets at once","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/targets/createtargets","routeSlug":"/ch/jobs-api/targets/createtargets","metadata":{"seo":{"title":"Create multiple job targets at once","description":"Creates new targets for the specified job and returns the job target IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateTargets","name":"Create multiple job targets at once","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1targets~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create multiple job targets at once","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates new targets for the specified job and returns the job target IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job target, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39605"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityPostCollectionResource"}},"schemaId":"components/schemas/EntityPostCollectionResource","pointer":"/paths/~1api~1jobs~1{id}~1targets~1bulk/post/requestBody","description":"The request containing target information."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/jobs/{id}/targets/bulk","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntityPostCollectionResource"}},"responseCodes":["200","201","400","401","404"],"pointer":"/api/jobs/{id}/targets/bulk","href":"targets/createtargets","openApiOperationId":"CreateTargets","summary":"Create multiple job targets at once"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/EntityPostCollectionResource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityPostCollectionResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityCreatedCollectionResource"}},"schemaId":"components/schemas/EntityCreatedCollectionResource"},{"code":"201","description":"Targets successfully created."},{"code":"400","description":"Request not valid (for example, less than or equal to zero), or target resources are null."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityCreatedCollectionResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityCreatedCollectionResource"}}},{"code":"201"},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/targets/createtargets"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/targets/bulk"},{"label":"Retrieve a specific job target","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/targets/jobtarget","routeSlug":"/ch/jobs-api/targets/jobtarget","metadata":{"seo":{"title":"Retrieve a specific job target","description":"Retrieves a job target using the job ID and the target ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"JobTarget","name":"Retrieve a specific job target","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a specific job target","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a job target using the job ID and the target ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"targetId","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target ID, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"34489"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cultures","in":"query","schemaId":"schema_1399","description":"List of cultures in which to load the entity. If no cultures are provided, multi-language properties are not included."}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/jobs/{id}/targets/{targetId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"},{"name":"targetId","in":"path","required":true,"schemaId":"schema_1398"}],"query":[{"name":"cultures","in":"query","schemaId":"schema_1399"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/jobs/{id}/targets/{targetId}","href":"targets/jobtarget","openApiOperationId":"JobTarget","summary":"Retrieve a specific job target"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"schemaId":"components/schemas/EntityResource"},{"code":"400","description":"Request or Job ID not valid (for example, less than or equal to zero or does not exist), or at least one culture is null."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityResource"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/targets/jobtarget"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/targets/{targetId}"},{"label":"Update a job target","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/targets/updatetarget","routeSlug":"/ch/jobs-api/targets/updatetarget","metadata":{"seo":{"title":"Update a job target","description":"Updates a target associated with a job. It ensures that both the job and target exist and that the user has access to them. Properties or relations not included in the request will be set to null."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateTarget","name":"Update a job target","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a job target","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a target associated with a job. It ensures that both the job and target exist and that the user has access to them. Properties or relations not included in the request will be set to null."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"targetId","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target ID, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39595"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"schemaId":"components/schemas/EntityResource","pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/put/requestBody","description":"The request containing the updated target information."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/jobs/{id}/targets/{targetId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"},{"name":"targetId","in":"path","required":true,"schemaId":"schema_1398"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"responseCodes":["204","400","401","404"],"pointer":"/api/jobs/{id}/targets/{targetId}","href":"targets/updatetarget","openApiOperationId":"UpdateTarget","summary":"Update a job target"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/EntityResource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation."},{"code":"400","description":"Request not valid or error during operation."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/targets/updatetarget"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/targets/{targetId}"},{"label":"Partially update a job target","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/targets/partialupdatetarget","routeSlug":"/ch/jobs-api/targets/partialupdatetarget","metadata":{"seo":{"title":"Partially update a job target","description":"Partial update on a target associated with a job. It ensures that the job and target exist and that the user has access to them. The properties and relations included in the request will be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PartialUpdateTarget","name":"Partially update a job target","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a job target","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partial update on a target associated with a job. It ensures that the job and target exist and that the user has access to them. The properties and relations included in the request will be updated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"targetId","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target ID, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39595"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"schemaId":"components/schemas/EntityResource","pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/patch/requestBody","description":"The request containing the updated target information."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/jobs/{id}/targets/{targetId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"},{"name":"targetId","in":"path","required":true,"schemaId":"schema_1398"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"responseCodes":["204","400","401","404"],"pointer":"/api/jobs/{id}/targets/{targetId}","href":"targets/partialupdatetarget","openApiOperationId":"PartialUpdateTarget","summary":"Partially update a job target"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"schemaId":"components/schemas/EntityResource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntityResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation."},{"code":"400","description":"Request not valid or error during operation."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/patch/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/targets/partialupdatetarget"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/targets/{targetId}"},{"label":"Delete a job target","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/jobs-api/targets/deletetarget","routeSlug":"/ch/jobs-api/targets/deletetarget","metadata":{"seo":{"title":"Delete a job target","description":"Deletes a target for a job using its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTarget","name":"Delete a job target","isWebhook":false,"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a job target","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a target for a job using its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the job, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39596"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"targetId","in":"path","schemaId":"schema_1398","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target ID, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39595"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/jobs/{id}/targets/{targetId}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_1398"},{"name":"targetId","in":"path","required":true,"schemaId":"schema_1398"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","404"],"pointer":"/api/jobs/{id}/targets/{targetId}","href":"targets/deletetarget","openApiOperationId":"DeleteTarget","summary":"Delete a job target"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Entity successfully deleted."},{"code":"400","description":"Request not valid or error during operation."},{"code":"401","description":"Unauthorized request."},{"code":"404","description":"Entity not found or user not authorized."}],"pointer":"/paths/~1api~1jobs~1{id}~1targets~1{targetId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/targets/deletetarget"}],"panels":[]}]},"httpPath":"/api/jobs/{id}/targets/{targetId}"}],"content":{"contentType":"group","meta":{"name":"Targets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Targets","showPageActions":true},{"nodeType":"markdoc","content":"A target entity is a target of a job (meaning a background process). Each job can have one or more targets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/jobs/{id}/targets","summary":"Create a job target","prefix":{"name":"post","color":"post"},"badges":[],"link":"/targets/createtarget","deprecated":false},{"title":"/api/jobs/{id}/targets","summary":"Retrieve all job targets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/targets/jobtargets","deprecated":false},{"title":"/api/jobs/{id}/targets/bulk","summary":"Create multiple job targets at once","prefix":{"name":"post","color":"post"},"badges":[],"link":"/targets/createtargets","deprecated":false},{"title":"/api/jobs/{id}/targets/{targetId}","summary":"Retrieve a specific job target","prefix":{"name":"get","color":"get"},"badges":[],"link":"/targets/jobtarget","deprecated":false},{"title":"/api/jobs/{id}/targets/{targetId}","summary":"Update a job target","prefix":{"name":"put","color":"put"},"badges":[],"link":"/targets/updatetarget","deprecated":false},{"title":"/api/jobs/{id}/targets/{targetId}","summary":"Partially update a job target","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/targets/partialupdatetarget","deprecated":false},{"title":"/api/jobs/{id}/targets/{targetId}","summary":"Delete a job target","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/targets/deletetarget","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/EntityCollectionResource":{"id":"components/schemas/EntityCollectionResource","kind":"json-schema","title":"EntityCollectionResource","data":{"type":"object","properties":{"last_hit_data":{"type":"array","items":{"type":"string"},"description":"The last returned hits, which are used to fetch the next page of results.","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/EntityResource"},"description":"Gets or sets the list of items.","nullable":true},"total_items":{"type":"integer","description":"Gets or sets the total number of items.","format":"int64","nullable":true},"returned_items":{"type":"integer","description":"Gets or sets the number of returned items.","format":"int64","nullable":true},"offset":{"type":"integer","description":"Gets or sets the offset of the items.","format":"int32","nullable":true},"next":{"$ref":"#/components/schemas/Link"},"previous":{"$ref":"#/components/schemas/Link"},"identifier":{"type":"string","description":"Gets or sets the identifier of the resource.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":{},"description":"Collection of entities that are the result of a query"}},"components/schemas/EntityCreatedCollectionResource":{"id":"components/schemas/EntityCreatedCollectionResource","kind":"json-schema","title":"EntityCreatedCollectionResource","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EntityCreatedResource"},"description":"Gets or sets the list of items.","nullable":true},"total_items":{"type":"integer","description":"Gets or sets the total number of items.","format":"int64","nullable":true},"returned_items":{"type":"integer","description":"Gets or sets the number of returned items.","format":"int64","nullable":true},"offset":{"type":"integer","description":"Gets or sets the offset of the items.","format":"int32","nullable":true},"next":{"$ref":"#/components/schemas/Link"},"previous":{"$ref":"#/components/schemas/Link"},"identifier":{"type":"string","description":"Gets or sets the identifier of the resource.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a collection resource of entities that have been created. Inherits from Stylelabs.M.Base.Web.Api.Models.ListResource`1."},"children":[]}]}]}]}},"components/schemas/EntityCreatedResource":{"id":"components/schemas/EntityCreatedResource","kind":"json-schema","title":"EntityCreatedResource","data":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the entity.","format":"int64"},"identifier":{"type":"string","description":"The identifier string for the entity.","nullable":true},"link":{"$ref":"#/components/schemas/Link"},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Represents a resource for a new created entity."}},"components/schemas/EntityLink":{"id":"components/schemas/EntityLink","kind":"json-schema","title":"EntityLink","data":{"type":"object","properties":{"properties":{"type":"object","additionalProperties":{"type":"object","nullable":true},"description":"Gets or sets the nested properties of the entity link.","nullable":true},"renditions":{"type":"object","additionalProperties":{"type":"object","nullable":true},"description":"Gets or sets the nested renditions of the entity link.","nullable":true},"permissions":{"type":"array","items":{"type":"string"},"description":"Gets or sets the nested permissions of the entity link.","nullable":true},"identifier":{"type":"string","description":"Gets or sets the nested identifier of the entity link.","nullable":true},"href":{"type":"string","description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"filename_properties":{"type":"array","items":{"type":"string"},"description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"title":{"type":"string","description":"Gets or sets the title that describes this link.","nullable":true},"templated":{"type":"boolean","description":"Gets or sets a value indicating whether the contained URI is a template.","default":false}},"additionalProperties":false,"description":"Represents a link to an entity with additional properties, renditions, permissions, and identifier."}},"components/schemas/EntityPostCollectionResource":{"id":"components/schemas/EntityPostCollectionResource","kind":"json-schema","title":"EntityPostCollectionResource","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EntityPostResource"},"description":"Gets or sets the list of items.","nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a collection resource for posting entities. Inherits from Stylelabs.M.Base.Web.Api.Models.ListResource`1."},"children":[]}]}]}]}},"components/schemas/EntityPostResource":{"id":"components/schemas/EntityPostResource","kind":"json-schema","title":"EntityPostResource","data":{"type":"object","properties":{"id":{"type":"integer","description":"Gets or sets the entity ID.","format":"int64","nullable":true},"identifier":{"type":"string","description":"Gets or sets the entity identifier.","nullable":true},"properties":{"type":"object","additionalProperties":{"type":"object","nullable":true},"description":"Gets or sets the properties of the entity.","nullable":true},"relations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RelationResource"},"description":"Gets or sets the relations of the entity.","nullable":true},"is_root_taxonomy_item":{"type":"boolean","description":"Gets or sets a value indicating whether the entity is a root taxonomy item.","nullable":true},"is_path_root":{"type":"boolean","description":"Gets or sets a value indicating whether the entity is a path root.","nullable":true},"entitydefinition":{"$ref":"#/components/schemas/Link"},"is_system_owned":{"type":"boolean","description":"Gets or sets a value indicating whether the entity is system owned."},"inherits_security":{"type":"boolean","description":"Gets or sets a value indicating whether the entity inherits security."},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Represents a resource for creating an entity."}},"components/schemas/EntityResource":{"id":"components/schemas/EntityResource","kind":"json-schema","title":"EntityResource","data":{"type":"object","properties":{"id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID for the entity, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"39752"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"int64"},"identifier":{"type":"string","description":"The identifier for the entity.","nullable":true},"cultures":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cultures associated with the entity, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"properties":{"type":"object","additionalProperties":{"type":"object","nullable":true},"description":"The properties of the entity.","nullable":true},"relations":{"type":"object","additionalProperties":{"type":"object","nullable":true},"description":"The relations of the entity.","nullable":true},"created_by":{"$ref":"#/components/schemas/Link"},"created_on":{"type":"string","description":"The date and time when the entity was created.","format":"date-time"},"modified_by":{"$ref":"#/components/schemas/Link"},"modified_on":{"type":"string","description":"The date and time when the entity was last modified.","format":"date-time"},"locked_by":{"$ref":"#/components/schemas/Link"},"locked_on":{"type":"string","description":"The date and time when the entity was locked.","format":"date-time","nullable":true},"entitydefinition":{"$ref":"#/components/schemas/Link"},"copy":{"$ref":"#/components/schemas/Link"},"copyasync":{"$ref":"#/components/schemas/Link"},"permissions":{"$ref":"#/components/schemas/Link"},"requested_permissions":{"type":"object","additionalProperties":{"type":"boolean","nullable":true},"description":"The requested permissions with identification if a certain user has permission.","nullable":true},"lifecycle":{"$ref":"#/components/schemas/Link"},"saved_selections":{"$ref":"#/components/schemas/Link"},"roles":{"$ref":"#/components/schemas/Link"},"annotations":{"$ref":"#/components/schemas/Link"},"is_root_taxonomy_item":{"type":"boolean","description":"Gets or sets a value indicating whether the entity is a root taxonomy item.","nullable":true},"is_path_root":{"type":"boolean","description":"Gets or sets a value indicating whether the entity is a path root.","nullable":true},"inherits_security":{"type":"boolean","description":"Gets or sets a value indicating whether the entity inherits security."},"is_system_owned":{"type":"boolean","description":"Gets or sets a value indicating whether the entity is system owned."},"version":{"type":"integer","description":"The version of the entity.","format":"int64"},"full":{"$ref":"#/components/schemas/Link"},"modules":{"type":"array","items":{"type":"string"},"description":"The modules associated with the entity.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":{},"description":"Represents an entity resource with various properties, relations and metadata."}},"components/schemas/JobDescriptionResource":{"id":"components/schemas/JobDescriptionResource","kind":"json-schema","title":"JobDescriptionResource","data":{"type":"object","properties":{"id":{"type":"integer","description":"The unique job description ID.","format":"int64","nullable":true},"identifier":{"type":"string","description":"The unique job description identifier.","nullable":true},"properties":{"type":"object","additionalProperties":{"type":"object","nullable":true},"description":"The job description properties.","nullable":true},"relations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RelationResource"},"description":"The job description relations.","nullable":true},"is_root_taxonomy_item":{"type":"boolean","description":"A value indicating whether the job description is a root taxonomy item.","nullable":true},"is_path_root":{"type":"boolean","description":"A value indicating whether the job description is a path root.","nullable":true},"entity_definition":{"$ref":"#/components/schemas/Link"},"is_system_owned":{"type":"boolean","description":"A value indicating whether the job description is system owned."},"inherits_security":{"type":"boolean","description":"A value indicating whether the job description inherits security."},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Represents a job description resource with various properties and relations."}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"type":"object","properties":{"href":{"type":"string","description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"filename_properties":{"type":"array","items":{"type":"string"},"description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"title":{"type":"string","description":"Gets or sets the title that describes this link.","nullable":true},"templated":{"type":"boolean","description":"Gets or sets a value indicating whether the contained URI is a template.","default":false}},"additionalProperties":false,"description":"Represents a link to a resource."}},"components/schemas/RelationResource":{"id":"components/schemas/RelationResource","kind":"json-schema","title":"RelationResource","data":{"type":"object","properties":{"parents":{"type":"array","items":{"$ref":"#/components/schemas/EntityLink"},"description":"The relation parents.","nullable":true},"parent":{"$ref":"#/components/schemas/EntityLink"},"children":{"type":"array","items":{"$ref":"#/components/schemas/EntityLink"},"description":"The relation children.","nullable":true},"child":{"$ref":"#/components/schemas/EntityLink"},"inherits_security":{"type":"boolean","description":"A value indicating whether the relation inherits security.","nullable":true},"parent_total":{"type":"integer","description":"Displays the total number of parents in the resource when the relation resource is limited.","format":"int64","nullable":true},"child_total":{"type":"integer","description":"Displays the total number of children in the resource when the relation resource is limited.","format":"int64","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Represents an relation resource."}},"schema_1398":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_1398"},"schema_1399":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_1399"},"schema_1400":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1400"},"schema_1401":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0},"id":"schema_1401"},"schema_1402":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":25},"id":"schema_1402"}},"exampleStore":{},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}},"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/ch/jobs-api/@v2.0/index.json?download"},{"url":"/_bundle/ch/jobs-api/@v2.0/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Jobs API","description":"Use the Jobs API to retrieve, create, update, and delete job targets or the description.\nThis REST API lets you interact with:\n  \n   - <i>M.Target</i> entities, which are targets of a job.\n   - The <i>M.JobDescription</i> entity, which contains information about what to do and what is in progress.\n\n{% admonition type=\"info\" name=\"Note\" %} To help you switch to the Jobs API, we provide [guidance on how to update calls in your code](https://doc.sitecore.com/ch/en/developers/cloud-dev/switch-to-the-jobs-api.html). {% /admonition %}\n\n ## Authentication\n\n To use the Jobs API, you need:\n\n  - The URL of your Content Hub server. You can get this from your Content Hub Administrator. Enter this URL in the <b>{{server}}</b> variable by hovering your mouse over the variable in the <b>Try it</b> pane and then clicking <b>Edit</b>.\n  - An [access token and the client ID](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#making-requests). Both are sent with every request. You can create a token through the [Content Hub interface](https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html)  or by [requesting one using the API itself](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#making-requests).\n","product":"Content Hub"}},"baseSlug":"/ch/jobs-api","routesMapping":{}}