Creativeforceconnector v1.0

/dsrc/datasourceproduct

Add/Update Product in Data Source

⚠️ Remarks

This API method only works for the data source type DataSourceFileUpload
Need to check the data source status DataReady before calling this API method
The product's property category is not allowed to be updated via this method.
If the product is in the status DONE, we not allow to update productCode and productName.
Based on the column mapping settings of the Data source, there is a column that will be mapped to the Product Code. When calling this API method, we will treat the input value in that column (as a key).
If the key already exists, product data will be _updated_ in the data source.
If the key does not exist, product data will be _inserted_ to the data source.
List of columns in this request MUST be exactly the same with the list of mapped columns in the “Column mapping” screen.
Data will be processed async in the background. You can check the last sync date time by calling to the API Get data source status.
Two continuous requests call to this method for the same Product Code within 1 second may be processed in a different order compared to the calling order.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Datasourceid`	Identifier of the data source to which the products are being added or updated.

/dsrc/datasource/144755e1-8fa0-4b2d-b114-0000

Get data source status by data source ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/dsrc/datasource

Get list data sources. Return top 1000 data sources in the studio with order by dataSourceName

clientId: (optional) when clientId has value this API will return a single active data source which is being used by that client in the list. If the client isn't using data source, an empty list will be returned.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Clientid`	Specify the Client which can be found in (Studio Settings>Clients)
`Response Type`	The response format expected from the API (e.g. application/json).

/annotations

Add new rejection/instruction note to asset

assetId: input asset in current step

stepId: step you want to add rejection/instruction to

annotations: object contain details of rejection/instruction

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/products/d0da01a3-cd52-4d6a-93f5-0000/add-color-references

Add new or replace color references of the product.

All error codes can be referred to at EnumProductAddColorReferencesErrorCode.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/jobs/import-async

An async method to import data to a job, including Product, Sample, Outfit, Color reference.
By default, if a product has no sample, Creative Force will create a sample for it. If you do not want that, set noDefaultSample value to 1, and you can add sample to your product later via API method Add samples to product.

You also can decide some actions as details below:

Action	Trigger	Enum
existingSampleActionId	When the importing sample is existing	ImportSampleAction
existingProductActionId	When the importing product is existing	ImportProductAction
doneProductActionId	When the importing product is already done	ImportProductAction

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Jobid`	You can find JobID from response of the Create Job method.
`Nodefaultsample`	Optional. Valid value: 0, 1 (default 0).
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Doneproductactionid`	Numeric identifier for the action to take on products that are already complete in the import.
`Existingproductactionid`	Numeric identifier for the action to take on products that already exist in the system.
`Existingsampleactionid`	Numeric identifier for the action to take on samples that already exist in the system.
`Updatefromdatasource`	Boolean flag indicating whether existing products should be updated from the data source during import.

/jobs/import-async-with-samples-only

An async method to import a job using Sample only. To use this API method, an active data source is required, so we can pull the Product information from that data source.

The sampleCode is required, the rest is optional. And the sampleCode must be existing in the data source as well.

If a sample's property is provided in the request body then we will use it, otherwise it will be enriched from the active data source.

You also can decide some actions as details below:

Action	Trigger	Enum
existingSampleActionId	When the importing sample is existing	ImportSampleAction
existingProductActionId	When the importing product is existing	ImportProductAction
doneProductActionId	When the importing product is already done	ImportProductAction
isImportRelatedSamples	When building a job from sample codes and a data source, you can choose to also import related samples under the same parent product	true - Import, false - Do not import

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Jobid`	You can find JobID from response of the Create Job method.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Doneproductactionid`	Numeric identifier for the action to take on products that are already complete in the import.
`Existingproductactionid`	Numeric identifier for the action to take on products that already exist in the system.
`Existingsampleactionid`	Numeric identifier for the action to take on samples that already exist in the system.
`Isimportrelatedsamples`	Boolean flag indicating whether related samples should also be imported alongside the products.

/v1/outfits/819d94ba-9f7c-4ca3-8bf7-0000/add-products

Add products to the outfit. Products have to be the same client with the outfit. You can sepecify sample of product that is used.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/products/d0da01a3-cd52-4d6a-93f5-0000/samples

You can import products without sample to a job, and then call this API to add samples to your product. You can find ProductID from response of the method Get Products.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Samplecode`	Unique code for the sample being added.
`Samplename`	Descriptive name of the sample.
`Sampleproductimages`	Array of URLs or references to images associated with the sample product.
`Samplereturndatetimeutc`	Numeric timestamp in UTC indicating when the sample is expected to be returned.
`Size`	Size specification for the sample, such as 'S', 'M', or 'L'.

/copywriting/tasks/{copywritingTaskId}/assignee

Assign a user for a Copywriting task

The user must be an existing user and currently set to active
The user must have the Copywriting Skill
User information can be searched through API: Get Users by Skill (/users/search)
With Copywrting SkillId is 10

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingtaskid`	Unique identifier of the copywriting task that will receive the assignee.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Userid`	Identifier of the user to assign as the copywriter for the task.

/copywriting/qctasks/{copywritingQcTaskId}/assignee

Assign a user for a Copywriting QC task

The user must be an existing user and currently set to active
The user must have the Copywriting QC Skill
User information can be searched through API: Get Users by Skill (/users/search)

With Copywrting QC SkillId is 11

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingqctaskid`	Unique identifier of the QC copywriting task that will receive the assignee.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Userid`	Identifier of the user to assign as the QC validator for the task.

/products/d0da01a3-cd52-4d6a-93f5-0000/change-product-style-guide

Change style guide for a Product. You can find ProductID from response of the method Get Products.

⚠️ Remarks

styleGuideInternalName (internal name, as in Add Products, required if styleGuideId is null)

styleGuideId (required if styleGuideInternalName is null or empty)

Only allowed when product is “To do” or “Backlog”.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Styleguideid`	Identifier of the new style guide to apply to the product.
`Styleguideinternalname`	Internal name of the new style guide to apply to the product.

/jobs

Create a new, empty job and validate the job code with it.

isAllowDuplicateJobCode: the boolean flag with a true or false value, the default value is false

If value is true: users can create a job with an existing job code.
If value is false: return the last created job ID with the flag _isNewJobCreated: false_ when users try to create a job using an existing job code.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/outfits

Create outfit & assign to an existing workunit. If the workunit already be assigned an another outfit, then a new workunit will be created.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Productid`	Identifier of the product to include in the outfit.
`Productiontypeid`	Numeric identifier for the type of production associated with the outfit.
`Sampleid`	Identifier of the sample to include in the outfit.

/products/d0da01a3-cd52-4d6a-93f5-0000/delete-color-references

Delete all color references of the product.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/jobs/bulk-delete

Delete list of jobs by job Ids and related samples (If "delete related sample" is set to true).
JobIds input array is allowed 1-100 Ids

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Deleterelatedsample`	Boolean flag indicating whether samples related to the deleted jobs should also be removed.
`Jobids`	Array of job identifiers to be deleted.

/outfits/819d94ba-9f7c-4ca3-8bf7-0000

Delete the outfit:

If the WorkUnit is the last WorkUnit by Production Type, then we keep the WorkUnit, and update its outfit as empty.
Else we also delete the WorkUnit.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/products/bulk-delete

Delete list of products by product Ids and related samples (If "delete related sample" is set to true).
ProductIds input array is allowed 1-100 Ids

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Deleterelatedsample`	Boolean flag indicating whether samples related to the deleted products should also be removed.
`Productids`	Array of product identifiers to be deleted.

/workunits/2bf7f064-6d7f-41b5-8a47-e07f72f1e844

Delete a WorkUnit and its outfit if existed. We don't allow deleting the last workUnit in a production type of the product, an error will be return in this case.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/d0da01a3-cd52-4d6a-93f5-0000/assets

Fetch Text Assets of completed steps

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/jobs/get-import-async-status

After importing a job, you can get the import status using this API. If there is any error, see the EnumImportLogicErrorCode for details.

⚠️ Remarks

The import status will be kept for maximum 24 hours. After 24 hours it will return a HTTP 400.
You should use the same user for both Import Job and Get Import Job Status, otherwise it will return a HTTP 400.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Jobid`	The JobID that returned from "Import Job"
`Importid`	The ImportID that returned from "Import Job"
`Response Type`	The response format expected from the API (e.g. application/json).

/products/get-move-products-status/56b16188-6478-45a6-a2f1-f8587cf35b30

After move products between jobs, you can get the move product status using this API. If there is any error, check the message in the body of the API result.

The move product status will be kept for maximum 60 minutes. After 60 minutes, it will return an HTTP 400.
You should use the same user for both Move Product and Get Move Product Status, otherwise it will return an HTTP 400.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/workunits/{copywritingWorkUnitId}/fields

Get layouts and fields with include content option for a Copywriting work unit by copywriting WorkUnitId

includeContent: true will fetch the pre-content of all fields

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingworkunitid`	Unique identifier of the copywriting work unit whose fields are being retrieved.
`Includecontent`	String flag to indicate whether the actual content of the fields should be included in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/tasks/{copywritingTaskId}/fields

Get runtime layout with fields content for a Copywriting task

includeContent: true will fetch the runtime content of all fields

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingtaskid`	Unique identifier of the copywriting task whose fields are being retrieved.
`Includecontent`	String flag to indicate whether the actual content of the fields should be included in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/qctasks/{copywritingQcTaskId}/fields

Get runtime layout with fields content for a Copywriting QC task

includeContent: true will fetch the runtime content of all fields

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingqctaskid`	Unique identifier of the QC copywriting task whose fields are being retrieved.
`Includecontent`	String flag to indicate whether the actual content of the fields should be included in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/products/d0da01a3-cd52-4d6a-93f5-0000/detectedlabel

Get detected label attributes for each Sample related to a Product by ProductId

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/jobs/b54d2bf9-0098-44b6-b274-4508c34a9348

Get detailed information about a Job by JobId.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/jobs/9e13a79f-dfd8-4709-8c76-0000/get-job-status-overview

Get Job Status Overview by jobId.

totalTask and doneTaskare excluded from disabled production types and deactivated products.
doneTask include: Done & Bypassed status.

Notes:

The result will be cached for 10 minutes.
If the job has more than 3000 products, it will return an error code EnumGetJobStatusOverview.TooManyProducts

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/outfits/819d94ba-9f7c-4ca3-8bf7-0000

Get detailed information about an outfit.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/outfits

List all outfits that are using this product.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Productid`	Identifier of the product for which outfits are being retrieved.
`Pagesize`	Maximum items per page: 100 items
`Pagenumber`	String representing the page number of results to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/task-processes/{taskProcessId}

Get process details:

Task & process info

Input assets

If parameter includeStyleGuideInfo = true then the response includes styleGuideName, styleGuideId, and positionName

Note: Return the id is existed, but you can submit-asset when the task status in (Todo / Inprogress / Rejected)

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Taskprocessid`	Unique identifier of the task process whose details are being retrieved.
`Includestyleguideinfo`	String flag to indicate whether style guide information should be included in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/products/attributes/b54d2bf9-0098-44b6-b274-4508c34a9348

Get detailed information about a Product by ProductId.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/products/b54d2bf9-0098-44b6-b274-4508c34a9348

Get detailed information about a Product by ProductId.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/products/get-status

Get product status by product code.

Requires either productId or productCode

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Productcode`	The product code identifying the product whose status you want to retrieve.
`Productid`	Identifier of the product for which outfits are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/workunits/get-production-state

Get info on production type on/off and position on/off on a product.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Productid`	Required. You can find ProductID from response of the method Get Products.
`Response Type`	The response format expected from the API (e.g. application/json).

/products

Get list of Products.

Params:

At least `jobId or productCode` is required
If both `jobId and productCode` has value, then the return result will satisfies both conditions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Jobid`	The job ID to filter products by a specific job.
`Productcode`	The product code to filter for a specific product.
`Clientid`	Specify the Client which can be found in (Studio Settings>Clients)
`Pagesize`	Maximum items per page: 100 items
`Pagenumber`	String representing the page number of results to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/outfits/819d94ba-9f7c-4ca3-8bf7-0000/products

List of products in an outfit. Max 100 products.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/styleguides

This method will list style guides by condition. All params are optional.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Clientid`	Specify the Client which can be found in (Studio Settings>Clients)
`Keyword`	Equal search for stylde guide name or stylde guide internal name
`State`	See EnumStyleGuideState (Enabled = 1 / Disabled = 0)
`Valid`	Valid (True/False)
`Pagesize`	Range [1-100]
`Pagenumber`	Start from 1
`Response Type`	The response format expected from the API (e.g. application/json).

/tasks/3f34675e-75a6-4be0-a2b8-0000/annotation

Get all annotations from all steps to the task including both instruction & rejection note.

Note:

Result is sorted by createdDate descending
Each asset is returned with a maximum of 30 latest annotations.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/capture/tasks/3f34675e-75a6-4be0-a2b8-0000

This API provides the task’s Style Guide and detailed information as instructions for the user to start working. Each position in the Style Guide requires a number of assets, defined as a Position.MinShots and Position.MaxShots. These numbers may be different and overwritten depending on the Position’s properties like IsOptional, IsEnforceAlts, and PositionSettingType.

Please refer to our help document to get more details information on the Style Guide.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/qctasks/{copywritingQcTaskId}/info

Get info about the Copywriting QC task, example:

Copywriter who completed the task prior to the Copywriting QC task

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingqctaskid`	Unique identifier of the QC copywriting task whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/tasks/3f34675e-75a6-4be0-a2b8-0000/styleguide

Get style guide of the task.
Return only single production type that’s matched to the task, and don’t filter position by condition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/workunits/2bf7f064-6d7f-41b5-8a47-e07f72f1e844

Get detailed information about a WorkUnit. You can find workUnitId from the response of the method Get Production State or Get Product Status.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/workunits/{copywritingWorkUnitId}

Get detailed information about a Copywriting Work Unit. You can find workUnitId from the response of the method Get Production State.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingworkunitid`	Unique identifier of the copywriting work unit whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/jobs

This method will list jobs by condition. All params are optional. To see the details of jobStatusId, please find EnumJobStatus

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Clientid`	Specify the Client which can be found in (Studio Settings>Clients)
`Jobcode`	Equal search for jobCode
`Jobname`	Equal search for jobName
`Pagesize`	Range [1-100]
`Pagenumber`	Start from 1
`Jobstatusids`	Accepts a list of EnumJobStatus values separated by commas. For example, it can be a single value like 1000 or multiple values such as 1000, 2000, 3000
`Response Type`	The response format expected from the API (e.g. application/json).

/products/move-products

Move a single product or products in bulk between jobs.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/tasks/{copywritingTaskId}/fieldscontent

Populate field content for a Copywriting task

fieldsContent: Is an array that contains the list of fieldIds and associated fieldContent to be populated into the specific task

The list of fields of a given task can be fetched through the API Get copywriting task fields (/tasks/fields)

Maximum items per request in the array is 20

Field content's format for a Single Line Text field:

JavaScript

{
  "fieldContent": {
    "textValue": "SingleLine Text Content"
  }
}

 ```

- Field content's format for a Text Area field:
    

``` json
{
  "fieldContent": {
    "markdownValue": "Rich text Content*\n1234"
  }
}

 ```

- Field content's format for selection fields like Care Instructions, Color and Predefined List:
    

``` json
{
  "fieldContent": {
    "selectedOptions": [
      {
        "id": "id1"
      }
    ]
  }
}

 ```

- Field content's format for Composition Material field:
    

``` json
{
  "fieldContent": {
    "materialComposition": {
      "components": [
        {
          "componentId": "componentId",
          "materials": [
            {
              "materialId": "materialId",
              "percentage": 50
            }
          ]
        }
      ],
      "disclaimers": [
        "disclaimerId"
      ]
    }
  }
}

 ```

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingtaskid`	Unique identifier of the copywriting task whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/qctasks/{copywritingQcTaskId}/fieldscontent

Populate field content for a Copywriting QC task

fieldsContent: Is an array that contains the list of fieldIds and associated fieldContent to be populated into the specific task

The list of fields of a given task can be fetched through the API Get copywriting Qc task fields (/qctasks/fields)

Maximum items per request in the array is 20

Field content's format for a Single Line Text field:

JavaScript

 {
  "fieldContent": {
    "textValue": "SingleLine Text Content"
  }
}

 ```

- Field content's format for a Text Area field:
    

``` json
{
  "fieldContent": {
    "markdownValue": "Rich text Content*\n1234"
  }
}

 ```

- Field content's format for selection fields like Care Instructions, Color and Predefined List:
    

``` json
{
  "fieldContent": {
    "selectedOptions": [
      {
        "id": "id1"
      }
    ]
  }
}

 ```

- Field content's format for Composition Material field:
    

``` json
{
  "fieldContent": {
    "materialComposition": {
      "components": [
        {
          "componentId": "componentId",
          "materials": [
            {
              "materialId": "materialId",
              "percentage": 50
            }
          ]
        }
      ],
      "disclaimers": [
        "disclaimerId"
      ]
    }
  }
}

 ```

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingqctaskid`	Unique identifier of the QC copywriting task whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/workunits/{copywritingWorkUnitId}/pre-content

Pre-populate content for Copywriting Work Unit by copywriting workUnitId

fieldsContent: Is an array that contains the list of fieldIds and associated fieldContent to be pre-populated into the specific Copywriting work unit
The list of fields of a given work unit can be fetched through the API Get Copywriting work unit fields (/workunits/fields)

Maximum items per request in the array is 20

Example of field content:

Field content's format for a Single Line Text field:

JavaScript

 {
  "fieldContent": {
    "textValue": "SingleLine Text Content"
  }
}

 ```

- Field content's format for a Text Area field:
    

``` json
{
  "fieldContent": {
    "markdownValue": "Rich text Content*\n1234"
  }
}

 ```

- Field content's format for selection fields like Care Instructions, Color and Predefined List:
    

``` json
{
  "fieldContent": {
    "selectedOptions": [
      {
        "id": "id1"
      }
    ]
  }
}

 ```

- Field content's format for Material Composition field:
    

``` json
{
  "fieldContent": {
    "materialComposition": {
      "components": [
        {
          "componentId": "componentId",
          "materials": [
            {
              "materialId": "materialId",
              "percentage": 50
            }
          ]
        }
      ],
      "disclaimers": [
        "disclaimerId"
      ]
    }
  }
}

 ```

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingworkunitid`	Unique identifier of the copywriting work unit whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/qctasks/{copywritingQcTaskId}/reject

Reject a Copywriting QC task by copywritingQcTaskId

Only allows submitting a task in To Do or In Progress status.

The task must mark at least one field to be “Rejected”.

The rejected fields must exist and be active in the configuration.

The fields are not disabled by condition

The fields are not in the disabled layout

The field type must be in types: _SingleLineText, TextArea, Color, Care Instruction, PredefinedList_

The comments must not be empty or whitespace (both fields comments and general comments).

The comment length must be less than 512.

QC Flag values can be found in the EnumCopywritingQcFlag section.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingqctaskid`	Unique identifier of the QC copywriting task whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/tasks/{taskId}/reject

Reject a task from current {taskId}.

In the payload:

transitionId: indicates the direction of the rejection. You can get the transitionId into Get Task Detail APIs, example GET /extpost/tasks/{taskId}

rejectedAssetIds: a subset of input assets that are not of sufficient quality to continue (in other words, they are a subset of output from the previous step that are not approved). If the list is empty, then all assets in the input list will be marked as rejected.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Taskid`	The unique identifier of the task to reject.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/outfits/819d94ba-9f7c-4ca3-8bf7-0000/remove-products

Remove Products from an Outfit.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/workunits/2bf7f064-6d7f-41b5-8a47-e07f72f1e844/reset-production

Reset Production a WorkUnit to a specific step.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/workunits/{copywritingWorkUnitId}/reset-production

Reset a Copywriting Work Unit to a specific task.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingworkunitid`	Unique identifier of the copywriting work unit whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Totaskid`	The task ID to which the work unit should be reassigned after reset.

/capture/tasks

Use search task endpoint to find photography task(s). This API takes a `Barcode and ShootingTypeId` as Input and returns a list of matching Photography Task(s).
For now, we only support E-comm tasks.
In the future, we will consider supporting Editorial tasks.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Barcode`	The barcode to search, usually a productCode
`Productiontypeid`	See EnumShootingType or response of API GET /productiontypes
`Status`	Optional. Query more than one status: separated by comma, ex: “2000”, “2000,5000”. Default all allowed statuses.
`Response Type`	The response format expected from the API (e.g. application/json).

/products/set-source

An async method to support change source. The sourceTypeId is required, it is Photo Production or Vendor Provided. The productVendorId is optional, it is null if the sourceTypeId is Photo Production. The workUnitIds is required, it is list of WorkUnitIds which is used to find out the updated WorkUnits. The last one is vpiDueDatetimeUtc, it is VPI due date (optional), and it is set null if the `sourceTypeId` is Photo Production.

The API response will seperate failWorkUnits and successWorkUnits. Error code can be referenced to EnumChangeSourceErrorCode

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/capture/tasks/submit-assets

Once the uploading to S3 completes, you should submit the assets and files by calling this API. Use the tempAssetId & tempFileId obtained from the API POST /assets/get-presigned-url and POST these as assetId & fileId to submit images to the task. We will verify if assets and files are uploaded correctly then the request is complete, your files and assets are successfully transferred to the Creative Force system.

Please note that tempAssetId & tempFileId are not reusable, if you want to upload exactly the same image to 2 positions, you need to upload it 2 times as two separated images.

On error, please refer to EnumCaptureSubmitTaskResultCode for more details.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/task-processes/{taskProcessId}/submit-assets

Submit assets for cloud automation task. All expected assets need to be submitted at once time.

We require all input assetId need to be in submit-assets, even your process don’t touch in the asset, in this case, outputResultTypeId should be set to 2

attr, position will be maintained in the output asset

Validation:

Required all assets from input need to be in output assets

Require output need at lease 1 main asset

Validate file extension type (image, video…)

Validate submit crop info must not null if cropInfoUpdateTypeId = 3

Number of asset match with style guide (do later)

CropInfo logic:

x, y, with, height: in pixels to specify rectangle of the crop

rotate (in degree -360 to 360), with anchor is center of the image (not be crop area)

scaleWidth, scaleHeight: after rotate & crop, we will scale the image to fit and not maintain image ratio

We haven’t supported scale yet

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Taskprocessid`	Unique identifier of the task process whose details are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/qctasks/{copywritingQCTaskId}/submit

Submit a Copywriting QC task by taskId

Only allows submitting a task in To Do or In Progress status

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingqctaskid`	The unique identifier of the QC task to submit.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/tasks/{copywritingTaskId}/submit

Submit a Copywriting task by taskId

Only allows submitting a task in To Do or In Progress status

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingtaskid`	Unique identifier of the copywriting task whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/workunits/{copywritingWorkUnitId}/trigger

Trigger a copywriting work unit:

Can only trigger for a product that has a trigger type is "Via API Gateway".

If the work unit is a bundle, trigger all related products that have trigger type "Via API Gateway".

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingworkunitid`	Unique identifier of the copywriting work unit whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/copywriting/workunits/{copywritingWorkUnitId}

Update custom properties for a Copywriting Work Unit.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Copywritingworkunitid`	Unique identifier of the copywriting work unit whose fields are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

/jobs/9e13a79f-dfd8-4709-8c76-0000

Update a Job. You can find the JobID from response of the Create Job method.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Clientid`	The client identifier to assign to the job.
`Deadlineutc`	The deadline for the job in UTC format as a number (e.g., Unix timestamp).
`Jobcode`	The job code to update for the job.
`Jobname`	The job name to update for the job.

/task-processes/{taskProcessId}/update-status

Update process status, only the below statuses are allowed:

7000: Mark the process/task as Failed status, workflow will be stopped at this step

8000: Skip this process and continue next (we will implement later)

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Taskprocessid`	Unique identifier of the task process whose details are being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Processstatusid`	The numeric identifier of the new process status to apply.

/products/d0da01a3-cd52-4d6a-93f5-0000

Update Properties for a Product. You can find ProductID from response of the method Get Products.

⚠️ Remarks

If the product's sample pool is being used by another product, we do not allow you to update productCode.

If the product's status is To Do or Backlog, Category update is allowed. If a Category update would trigger a Style Guide change, the API response includes the new Style Guide details (ID and name)

If products' status is InProgress or Done, Category update is not permitted

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Brand`	The brand name to set for the product.
`Category`	The category to assign to the product.
`Color`	The color value to set for the product.
`Productcode`	The product code to update for the product.
`Productname`	The product name to update for the product.
`Stylecode`	The style code to set for the product.

/products/d0da01a3-cd52-4d6a-93f5-0000/update-state

Update state of a product. See EnumProductState for more details info.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Productstateid`	The numeric identifier of the product state to apply.

/workunits/update-production-state

Toggle a production type on/off or a position on/off on a product.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Isdisabled`	Set to true to disable the work unit, or false to enable it.
`Workunitid`	The unique identifier of the work unit whose production state you want to update.

/copywriting/workunits/update-production-state

Toggle a production type on/off or a layout on/off on a configuration.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Isdisabled`	Set to true to disable the work unit, or false to enable it.
`Workunitid`	The unique identifier of the work unit whose production state you want to update.

/jobs/update-from-datasource

Body's limit is 10 JobIds per call

Note: After a jobId is called by this API to update from data source, it will take time to process.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Jobids`	Array of job identifiers to be deleted.

/workunits/2bf7f064-6d7f-41b5-8a47-e07f72f1e844

Update properties of a WorkUnit.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/assets/assign/deliverable

Once the uploading Assets (files) to S3 completes, you can assign Assets to Deliverable by calling this API. Use the tempAssetId obtained from the API POST /assets/get-presigned-url and POST these as assetId to assign Assets to Deliverable. We will verify if assets are uploaded correctly then the request is complete and your assets are successfully transferred to the Creative Force system.

Please note that tempAssetId is not reusable.

You can find deliverableId from the response of the method List Deliverables.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Assetids`	An array of asset identifiers to assign to the deliverable.
`Deliverableid`	The unique identifier of the deliverable to which the assets should be assigned.
`Isselected`	Set to true to mark the assigned assets as selected for the deliverable.

/editorial/assets/assign/project

Once the uploading Assets (files) to S3 completed, you can assign Assets to Project by calling this API. Use the tempAssetId obtained from the API POST /assets/get-presigned-url and POST these as assetId to assign Assets to Project. We will verify if assets are uploaded correctly then the request is complete and your assets are successfully transferred to the Creative Force system.

Please note that tempAssetId is not reusable.

You can find projectId from the response of the method List Projects.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Assetids`	An array of asset identifiers to assign to the project.
`Projectid`	The unique identifier of the project to which the assets should be assigned.

/editorial/documents/attrach-from-url

Create a document from Cloud Resource

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/documents/attach-from-file

Attach list of document files to Project.

This API only support file upload with some extensions: .jpg, .jpeg, .png, .psd, .tif, .tiff, .eps, .pdf, .doc, .docx, .xls, .xlsx, .indd, .txt, .csv, .ppt, .pptx, .key

Once the uploading to S3 completes, you should submit the files by calling this API. Use the tempFileId obtained from the API POST {{baseUrl}}/assets/get-presigned-url and POST these as fileId to submit the documents to the Project. We will verify if files are uploaded correctly then the request is complete, your files are successfully transferred to the Creative Force system.

Please note that tempFileId are not reusable.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Projectid`	The unique identifier of the project to which the documents should be attached.
`Tempfileids`	An array of temporary file identifiers that represent the uploaded files to attach.

/editorial/deliverables

Create new a Deliverable. You can find projectId from the response of the method List Projects.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/projects

Create a new Project.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/deliverables/014e9814-9921-4583-95b9-3c4dd8c326dc

Delete a Deliverable. You can find deliverableId from the response of the method List Deliverables.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/projects/a5038f83-0c66-44bd-9292-ecaad228a514

Delete a Project. You can find projectId from the response of the method List Project.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/documents

Delete list of documents by document Ids. DocumentIds input array is allowed 1-50 Ids.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/deliverables/014e9814-9921-4583-95b9-3c4dd8c326dc

Get detail information about a Deliverable. To see the details of deliverableStatusId, please find EnumEditorialDeliverableStatus.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/projects/a5038f83-0c66-44bd-9292-ecaad228a514

Get detailed information about a Project. To see the details of projectStatusId, please find EnumEditorialProjectStatus.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/assets

This method will list editorial assets by condition.
Params:

At least projectId or deliverableId is required
If both projectId and deliverableId has value, then the return result will satisfies both conditions.
You can find projectId from the response of the method List Projects.
You can find deliverableId from the response of the method List Deliverables.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Projectid`	You can find projectId from the response of the method List Projects.
`Deliverableid`	You can find deliverableId from the response of the method List Deliverables.
`Pagesize`	Range [1-100]
`Pagenumber`	Start from 1
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/deliverables

This method will list Deliverables by condition. To see the details of deliverableStatusId, please find EnumEditorialDeliverableStatus.

Params:

At least projectId or deliverableCode is required.
If both projectId and deliverableCode has value, then the return result will satisfy both conditions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Projectid`	You can find projectId from the response of the List Projects method.
`Deliverablecode`	Equal search for deliverableCode
`Pagesize`	Range [1-100]
`Pagenumber`	Start from 1
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/projects

This method will list projects by condition. All parameters are optional. To see the details of projectStatusId, please find EnumEditorialProjectStatus.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Clientid`	Specify the Client which can be found in (Studio Settings>Clients)
`Projectcode`	Equal search for projectCode
`Pagesize`	Range [1-100]
`Pagenumber`	Start from 1
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/deliverables/014e9814-9921-4583-95b9-3c4dd8c326dc

Update a Deliverable. You can find deliverableId from the response of the methodList Deliverables.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/projects/a5038f83-0c66-44bd-9292-ecaad228a514

Update a Project. You can find projectId from the response of the method List Project.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/documents/3db56533-3122-4b69-92d1-02f5769a5701

Update new document version for a document

Note: We only support update a document via upload file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Tempfileid`	The temporary file identifier of the uploaded file that should replace the document's current file.

/specs/bulk-get-specs

Get list of spec information. Max 100 specs.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of option objects or identifiers to filter or specify which specs to retrieve.

/editorial/specs/bulk-get-specs

Get list of spec information. Max 100 specs.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of option objects or identifiers to filter or specify which specs to retrieve.

/v1/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000/annotation

Get external post task annotation (instruction & rejection note)

Note:

Result is sorted by createdDate descending
Each assets are returned maxinum 30 latest annotations.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000/annotation

This method will list annotations of Editorial External Post Task, include instructions and reject information

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000

Get external post task detail:

Task info
Input assets, and their expected output assets
If parameter includeStyleGuideInfo = true then response include styleGuideName, styleGuideId and positionName

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Includestyleguideinfo`	Optional, accept value true/false
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000

Get detail information of an Editorial External Post Task

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/extpost/tasks

Get list external post production task.

Params:

postProductionVendorId (guid): Id of the External Production Vendor (required)
The postProductionVendorId can be copied via a context menu in Gamma.
Only allow type “Creative Force - Gateway API”
status (number)
Allow multiple value of task status: Todo, In progress, Rejected
Query more than one status: separated by comma, ex: “2000”, “2000,5000”
Default all allowed statuses
contentCreationTypeId (number optional)
Value as EnumContentCreationType: 1=Ecomm, 2=Editorial
pageNumber: number of the page (optional, start from 1, default=1)
pageSize: maxinum number of item in output(optional, default=10, max=100)

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Postproductionvendorid`	Filter tasks by the unique identifier of the post-production vendor.
`Status`	Filter tasks by their current status (e.g., pending, in progress, completed).
`Contentcreationtypeid`	Filter tasks by the unique identifier of the content creation type.
`Pagenumber`	String representing the page number of results to retrieve.
`Pagesize`	Specify the number of tasks to return per page for paginated results.
`Response Type`	The response format expected from the API (e.g. application/json).

/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000/start

Start a external post task.

The task status will be updated to “In progress”.

Todo, Rejected update to In progress & return success.

In progress: do nothing & return success.

Other statuses: return an error.

---

If vendorInfo is set, we will update Vendor Task ID and Vendor Task Status to allow Creative Force users to see the status of the vendor production.

vendorTaskId & vendorTaskStatus both have a max length of 128

vendorTaskId is the key in the list of vendorTaskDetails

vendorTaskDetails can have a maximum of 100 items

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000/start

Start Editorial External Post Task

---

If vendorInfo is set, we will update Vendor Task ID and Vendor Task Status to allow Creative Force users to see the status of the vendor production.

vendorTaskId & vendorTaskStatus both have a max length of 128

vendorTaskId is the key in the list of vendorTaskDetails

vendorTaskDetails can have a maximum of 100 items

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000/submit-assets

Submit assets for external post task. All expected assets need to be submitted at once time. For rejection case, only correction assets are required.

All error codes can be referred to at EnumSubmitExternalPostTaskErrorCode.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Inputassetid`	The unique identifier of the asset to submit as input for the post-production task.

/editorial/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000/submit-assets

Submit assets for external post task.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Inputassetid`	The unique identifier of the asset to submit as input for the post-production task.

/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000/submit-assets-v2

Submit assets for external post task. All expected assets need to be submitted at once time. For rejection case, only correction assets are required.

Support transitionId for V2.

All error codes can be referred to at EnumSubmitExternalPostTaskErrorCode.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000/update-vendor-info

Update Vendor Task ID and Vendor Task Status to allow Creative Force users to see the status of the vendor production.

vendorTaskId & vendorTaskStatus both have a max length of 128

vendorTaskId is the key in the list of vendorTaskDetails

vendorTaskDetails can have a maximum of 100 items

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/editorial/extpost/tasks/3f34675e-75a6-4be0-a2b8-0000/update-vendor-info

Update Vendor Task ID and Vendor Task Status to allow Creative Force users to see the status of the vendor production.

vendorTaskId & vendorTaskStatus both have a max length of 128

vendorTaskId is the key in the list of vendorTaskDetails

vendorTaskDetails can have a maximum of 100 items

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/assets/bulk-get-assets

Get list of asset information. Max 100 assetIds.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of asset identifiers or filter options to specify which assets to retrieve.

/assets

Get Assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Productid`	Required. You can find ProductID from response of the method Get Products.
`Productiontypeid`	Required. Type: EnumShootingType
`Stepid`	Required. Type: EnumStep
`Selectiontypeid`	Optional. Type: EnumAssetSelectionType (default empty ~ not filter)
`Ishero`	Optional. Type: true/false/empty (default empty ~ not filter)
`Isinclip`	Optional. Type: true/false/empty (default empty ~ not filter)
`Isresource`	Optional. Type: true/false/empty (default empty ~ not filter)
`Pagesize`	Optional. Type: integer in [1-100] (default 10)
`Pagenumber`	Optional. Type: integer (default 1)
`Varianttype`	Optional. Type: integer (1: main only \| 2: variants only \| 0: all - default)
`Variantcode`	Optional. Type: string (support multiple variant code, split by comma)
`Response Type`	The response format expected from the API (e.g. application/json).

/files/bulk-get-files

Get list of file information. Max 100 fileIds.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of file identifiers or filter options to specify which files to retrieve.

/assets/get-presigned-url

In order to upload files to Amazon S3, you need to generate pre signed-urls first. We will return a list of tempFileId and tempAssetId for further mapping to the CF system.

The tempAssetId is using to upload asset.
The tempFileId is using to upload non-asset, such as color reference.

If you want to manage these file using your own ID, you can use the localId parameter. In the response, we will return the original input value of this parameter.

Beside this, we also return the x-amz-server-side-encryption and x-amz-server-side-encryption-aws-kms-key-id so you can use them in the next step to upload files to Amazon S3.

When some input files aren't passed validation, they will be returned in array of errorFiles, detail of errorCode you can look up at EnumTempFileValidationError

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/temp/4d3e381e-xxxx-xxxx-xxxx-032f2ddf8d85/480e8a76-xxxx-xxxx-xxxx-06551da4051c/Asset/f48fd526-xxxx-xxxx-xxxx-3d920c7b636f/example.jpg

Now with the pre-signed URL, you can directly upload your file (or your binary data stream) to Amazon S3. All query params already included in the pre-signed URL. You will need to put some headers values, which can get from the Get pre-sign URL API. Here is a sample .NET code to uploads an object to an Amazon S3 bucket using the presigned URL.

Reference: https://docs.aws.amazon.com/AmazonS3/latest/dev/PresignedUrlUploadObject.html

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`X-amz-expires`	The expiration time in seconds for the pre-signed URL.
`X-amz-algorithm`	The signing algorithm used for the pre-signed URL (e.g., AWS4-HMAC-SHA256).
`X-amz-signedheaders`	A semicolon-separated list of headers that are signed in the request.
`X-amz-security-token`	The security token for temporary credentials, if applicable.
`X-amz-credential`	The credential scope for the pre-signed URL, including access key and region.
`X-amz-date`	The date and time used in the signature, formatted as ISO 8601.
`X-amz-signature`	The calculated signature for authenticating the upload request.
`X-amz-server-side-encryption`	Required: Get from Get-PreSigned-Url endpoint
`X-amz-server-side-encryption-aws-kms-key-id`	Required: Get from Get-PreSigned-Url endpoint
`Response Type`	The response format expected from the API (e.g. application/json).

/samples/change-container

This endpoint allows you to change the container of samples by targetContainerId.

targetContainerId: A unique identifier for the container.
If targetContainerId is null, all samples associated with the specified sampleIds entries will be released.

sampleIds: A list of sample IDs to be changed to the specified container. (required)

The list can contain a maximum of 100 items.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/samples/change-location

This endpoint allows you to move a list of samples to a new location by locationId. If the sample has not been released, it cannot be moved to a new location.

locationId: A unique identifier for the location where samples will be relocated. (required)

sampleIds: A list of sample IDs to be moved to the specified location.

The list can contain a maximum of 100 items.

productIds: A list of product IDs. If the product exists and has related samples, all related samples will be moved to the specified location.

The list can contain a maximum of 20 items.

The number of related samples does not exceed 200 items.

At least one of sampleIds or productIds is required. If both are provided, all matching samples will be retrieved and moved to the specified location.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/containers

This endpoint allows you to create a list of containers with a specified code.

typeId: A value representing the type of the container. (required)

codes: Array of Strings of container codes. (required)

The value of each container code cannot be empty.

Duplicate container codes are not allowed.

Each container code must not exceed 128 characters.

The list can contain a maximum of 50 items.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/locations

This endpoint allows you to create a new location in the system.

name: A string representing the location's name. (max length: 256 chars)

code: A unique identifier for the location, restricted to English characters. (max length: 256 chars)

typeId: An integer specifying the location type (refer to EnumLocationType for valid values).

isEnabled: A boolean indicating if the location is active and usable.

isCheckedIn: Aboolean indicating if the location is a checked in location

address: A string representing the location's street address. (max length: 2048 chars)

zipCode: A string representing the location's postal code. (max length: 64 chars)

city: A string representing the city where the location is situated. (max length: 1024 chars)

countryCode: A two-letter ISO country code, e.g., "US" for united states. Refer to the IANA Time Zone Database (https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab) for a complete list of valid codes.

properties: An object containing key-value pairs for additional attributes related to the location.
Keys are unique identifiers.

Values must not exceed 2048 chars.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/locations/{locationId}/sub-locations

This endpoint allows you to create a new sub-location under an existing location specified by the locationId.

name: A string representing the location's name. (max length: 256 chars)

code: A unique identifier for the location, restricted to English characters. (max length: 256 chars)

typeId: An integer specifying the location type (refer to EnumLocationType for valid values).

isEnabled: A boolean indicating if the location is active and usable.

isCheckedIn: Aboolean indicating if the location is a checked in location

address: A string representing the location's street address. (max length: 2048 chars)

zipCode: A string representing the location's postal code. (max length: 64 chars)

city: A string representing the city where the location is situated. (max length: 1024 chars)

countryCode: A two-letter ISO country code, e.g., "US" for united states. Refer to the IANA Time Zone Database (https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab) for a complete list of valid codes.

properties: An object containing key-value pairs for additional attributes related to the location.
Keys are unique identifiers.

Values must not exceed 2048 chars.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Locationid`	The unique identifier of the parent location under which the sub-location will be created.
`Response Type`	The response format expected from the API (e.g. application/json).

/containers/{containerId}

This endpoint allows you to delete an existing container identified by the containerId.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Containerid`	The unique identifier of the container to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/locations/{locationId}

This endpoint allows you to delete an existing location identified by the locationId. A location cannot be deleted if there are containers in use at that location.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Locationid`	The unique identifier of the location to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/samples/bulk-delete

Delete list of samples by sample Ids. SampleIds input array is allowed 1-100 Ids

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Sampleids`	Supply an array of sample ID strings that identify the samples to be deleted.

/styling/get-import-styling-status

After importing styling items, you can get the import status using this API. The import status will be kept for 24 hours. If there is any error, see the EnumImportLogicErrorCode for details.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Clientid`	The ClientId that returned from "Import Styling Wardrobe"
`Importid`	The ImportID that returned from "Import Styling Wardrobe"
`Response Type`	The response format expected from the API (e.g. application/json).

/containers/{containerId}

This endpoint retrieves detailed information about a specific container identified by its unique containerId. It provides relevant attributes and properties associated with the container.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Containerid`	The unique identifier of the container to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/containers

This endpoint retrieves a paginated list of containers based on the specified query parameters. It allows for filtering by various criteria, including type, status, and keyword search.

Query Parameters

pageNumber: (optional) An integer specifying the page number for result retrieval. Default is 1.

pageSize: (optional) An integer specifying the number of results per page. Default is 10.

typeId: (optional) An integer used to filter locations by their type. Use valid values from EnumLocationType.

isEnabled: (optional) A boolean to return only enabled locations. Set to true to filter for active locations.

keyword: (optional) A string for searching locations by name or other relevant attributes. If not specified, all matching locations will be retrieved.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Pagenumber`	String representing the page number of results to retrieve.
`Pagesize`	Specify the number of tasks to return per page for paginated results.
`Typeid`	Filter containers by their type using the type identifier string.
`Isenabled`	Filter by enabled status; provide a string representing true or false.
`Keyword`	Search for containers matching a keyword string in their attributes.
`Response Type`	The response format expected from the API (e.g. application/json).

/samples/9377c762-c606-49ab-b16c-99e683f7097f/detectedlabel

Get label images and detected atrributes by SampleId.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/locations/{locationId}

This endpoint retrieves detailed information about a specific location identified by its unique locationId. It provides relevant attributes and properties associated with the location.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Locationid`	The unique identifier of the location to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/locations

This endpoint retrieves a paginated list of locations based on the specified query parameters. It allows for filtering by various criteria, including the parent location ID, type, status, and keyword search.

Query Parameters

pageNumber: (optional) An integer specifying the page number for result retrieval. Default is 1.
pageSize: (optional) An integer specifying the number of results per page. Default is 10.
parentId: (optional) A string representing the parent location's ID. If not specified, it retrieves locations of all levels.
typeId: (optional) An integer used to filter locations by their type. Use valid values from EnumLocationType.
isEnabled: (optional) A boolean to return only enabled locations. Set to true to filter for active locations.
keyword: (optional) A string for searching locations by name or other relevant attributes. If not specified, all matching locations will be retrieved.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Pagenumber`	String representing the page number of results to retrieve.
`Pagesize`	Specify the number of tasks to return per page for paginated results.
`Parentid`	Filter locations by their parent location using the parent identifier string.
`Typeid`	Filter locations by their type using the type identifier string.
`Isenabled`	Filter by enabled status; provide a string representing true or false.
`Keyword`	Search for locations matching a keyword string in their attributes.
`Response Type`	The response format expected from the API (e.g. application/json).

/samples/b54d2bf9-0098-44b6-b274-4508c34a9348

Get detailed information about a Sample by SampleId.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/samples

Get list of Samples

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Samplepoolid`	You can find SamplePoolID from response of the Get Products method.
`Pagesize`	Maximum items per page: 100 items.
`Pagenumber`	String representing the page number of results to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/styling/import-styling

Import styling items and styling item samples.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Clientid`	specify the Client which can be found in (Studio Settings>Clients) or you can leave it empty and it will take the Default Client.
`Response Type`	The response format expected from the API (e.g. application/json).

/containers/move-containers

This endpoint allows you to relocate a list of containers to a specified location identified by its location ID.

locationId: A unique identifier for the location where the containers will be relocated.

containerIds: A list of container IDs to be moved to the specified location.

The list can contain a maximum of 50 items.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Containerids`	Supply an array of container ID strings that identify the containers to move.
`Locationid`	Provide the destination location identifier string where the containers should be moved.

/containers/{containerId}

This endpoint allows you to update the details of an existing container identified by the containerId.

code: A unique identifier for the container. (max length: 128 chars)

typeId: An integer specifying the container type (refer to EnumContainerType for valid values).

isEnabled: A boolean indicating if the container is enabled.

properties: An object containing key-value pairs for additional attributes related to the location.

Keys are unique identifiers.

Values must not exceed 2048 chars.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Containerid`	The unique identifier of the container to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/locations/{locationId}

This endpoint allows you to update the details of an existing location identified by the locationId.

name: A string representing the location's name. (max length: 256 chars)
code: A unique identifier for the location, restricted to English characters. (max length: 256 chars)
typeId: An integer specifying the location type (refer to EnumLocationType for valid values).
isEnabled: A boolean indicating if the location is active and usable.
isCheckedIn: Aboolean indicating if the location is a checked in location
address: A string representing the location's street address. (max length: 2048 chars)
zipCode: A string representing the location's postal code. (max length: 64 chars)
city: A string representing the city where the location is situated. (max length: 1024 chars)
countryCode: A two-letter ISO country code, e.g., "US" for united states. Refer to the IANA Time Zone Database (https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab) for a complete list of valid codes.
properties: An object containing key-value pairs for additional attributes related to the location.
Keys are unique identifiers.
Values must not exceed 2048 chars.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Locationid`	The unique identifier of the location to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/samples/9377c762-c606-49ab-b16c-99e683f7097f

Update properties for a Sample

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Samplecode`	Set the sample's code using a string value.
`Samplename`	Set the sample's name using a string value.
`Samplereturndatetimeutc`	Set the sample's return date and time in UTC as a numeric timestamp.
`Size`	Set the sample's size using a string value (e.g., a size description).

/samples/change-type

Change Sample Type from Product Sample to Styling Sample and vice versa.
To set the `targetType` please see EnumProductType

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Sampleid`	Identifier of the sample to include in the outfit.
`Targettype`	Provide the numeric identifier of the target sample type to assign.

/clients

Get list of Clients

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Pagesize`	Maximum items per page: 100 items
`Pagenumber`	String representing the page number of results to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/customproperties

Get a list of custom properties.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Objecttypeid`	Please find EnumObjectType in the Enumeration section
`Pagesize`	Maximum items per page: 100 items
`Pagenumber`	String representing the page number of results to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/productvendors

A method to get product vendor list. We can filter the list by adding value to `keyword` parameter, then the list will be filtered by product vendor name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Pagesize`	Maximum items per page: 500 items
`Pagenumber`	Page number
`Keyword`	Name of the Vendor team, URL encoded
`Response Type`	The response format expected from the API (e.g. application/json).

/productiontypes

Get a list of active production types. `keyword` parameter can be use to filter the production type name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Pagenumber`	String representing the page number of results to retrieve.
`Pagesize`	Maximum items per page: 100 items
`Keyword`	The whole or a part of Production Type Name
`Response Type`	The response format expected from the API (e.g. application/json).

/sessions/{sessionId}/productions

Assign Production to Session with the following data:

sessionId: The id of a session that want to add new production.

productionIds:
An array of production ids.
Ecomm: WorkUnit ids.
Editorial: Deliverable ids.
The array can contain maximum 50 ids.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which productions will be assigned.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Productionids`	Supply an array of production ID strings that identify the productions to assign.

/sessions/{sessionId}/teammembers

Assign User to Session Team with the following data:

sessionId: The id of a session.
newTeamMembers:

An array of user ids with their skill that want to assign to the session.

The array can contain maximum 50 team members.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/sessions

Create a new session with the following data:

name: Name of the session.
The value can be empty or maximum is 256 characters.
description: Description of the session.
The value can be empty or maximum is 1024 characters.
contentCreationTypeId: EnumContentCreationType.
1 - Ecomm.
2 - Editorial.
productionTypeId: Production type of the session.
For contentCreationTypeId = 2 (Editorial), the productionTypeId must be null.
clientId: The value can be empty or null.
The value can be empty or null if the Session Client Control setting is "Multiple & Single Client Sessions".
If the value is not empty and not null then it must be in GUID format.
locationId: The value can be empty or null.
If the value is not empty and not null then it must be in GUID format.
producerId: The value can be empty or null.
If the value is not empty and not null then it must be in GUID format.
timeZone: A string field that represents TimeZone IANA.
Example: Europe/Paris, Europe/Berlin.
Reference: https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab
timeSlots: An array that contains timeslot objects.
The array must be at least 1 element and maximum is 20 elements.
teamMembers: An array that contains team member objects.
The array can be empty or contain maximum 50 team members
customProperties: An array that contains session custom properties.

The array can be empty or contain maximum 200 properties

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Contentcreationtypeid`	The numeric identifier for the type of content creation associated with the session.
`Description`	A text description providing additional context for the session.
`Locationid`	Provide the destination location identifier string where the containers should be moved.
`Name`	The display name to assign to the session.
`Producerid`	The identifier of the producer responsible for the session.
`Productiontypeid`	Numeric identifier for the type of production associated with the outfit.
`Timezone`	The time zone to use for session scheduling and display.

/sessions/{sessionId}

Delete a session by SessionId

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/sessions/{sessionId}/productions

Get list productions of the session by SessionId

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/sessions/{sessionId}

Get session detail by SessionId.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/sessions/{sessionId}/teammembers

Get all team members of a session.

sessionId: The id of a session.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/sessions/{sessionId}/productions/move

Move Production from a session to another session.

sessionId: The id of source session that contains list of moving production.

otherSessionId: The id of destination session.
productionIds:
An array of production ids.
The array can contain maximum 50 ids.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Othersessionid`	The identifier of the session to which the production should be moved.
`Productionids`	Supply an array of production ID strings that identify the productions to assign.

/sessions/{sessionId}/productions

Un-assign Production from Session with the following data:

sessionId: The id of a session that want to remove production.

productionIds:
An array of production ids.
The array can contain maximum 50 ids.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Productionids`	Supply an array of production ID strings that identify the productions to assign.

/sessions/{sessionId}/teammembers

Un-assign User from Session Team with the following data:

sessionId: The id of a session.
sessionTeamMemberIds:

An array of session team member ids of the session (not user ids).

The array can contain maximum 50 team members.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Sessionteammemberids`	An array of identifiers for the session team members to unassign.

/sessions/{sessionId}

Update a session with the following data:

name: Name of the session.
The value can be empty or maximum is 256 characters.
description: Description of the session.
The value can be empty or maximum is 1024 characters.
contentCreationTypeId: EnumContentCreationType.
1 - Ecomm.
2 - Editorial.
productionTypeId: Production type of the session.
For contentCreationTypeId = 2 (Editorial), the productionTypeId must be null.
clientId: The value can be empty or null.
The value can be empty or null if the Session Client Control setting is "Multiple & Single Client Sessions".
If the value is not empty and not null then it must be in GUID format.
locationId: The value can be empty or null.
If the value is not empty and not null then it must be in GUID format.
producerId: The value can be empty or null.
If the value is not empty and not null then it must be in GUID format.
timeZone: A string field that represents TimeZone IANA.
Example: Europe/Paris, Europe/Berlin.
Reference: https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab
timeSlots: An array that contains timeslot objects.
The array must be at least 1 element and maximum is 20 elements.
customProperties: An array that contains session custom properties.

The array can be empty or contain maximum 200 properties

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Contentcreationtypeid`	The numeric identifier for the new content creation type to assign to the session.
`Description`	The updated text description for the session.
`Locationid`	Provide the destination location identifier string where the containers should be moved.
`Name`	The new display name for the session.
`Producerid`	The identifier of the new producer to assign to the session.
`Productiontypeid`	Numeric identifier for the type of production associated with the outfit.

/sessions/{sessionId}/teammembers

Un-assign User from Session Team with the following data:

sessionId: The id of a session.
teamMembers:

An array of session team member ids with new skill id (not user ids).

The array can contain maximum 50 team members.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Sessionid`	Provide the session identifier string that identifies the session to which the user will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/users/resource-users

Description

Create new resource users. You can create up to 30 users in a single request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/users/resource-users/657722e1-82a0-4b33-b122-0331

Description

Delete resource user with the following data:

userId (Required): The unique identifier of the resource user you want to delete.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/users/resource-users/skills

Get resource user skills

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/users/resource-users/search

Search resource users by state (enabled/disabled), skills, keywords and employment type.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/users/resource-users/657722e1-82a0-4b33-b122-0331

Update firstName, lastName, employmentTypeId and skills of a resource user

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/tasks

Description

Get List of the tasks based on filter

Params:
stepId: int (required)
productionTypeId: int (optional)
clientId: guid (optional)
status: (optional)
Allow multiple value of task status: Todo, In progress, Rejected
Query more than one status: separated by comma, ex: “2000”, “2000,5000”
Default all allowed statuses
contentCreationTypeId (number optional)
Value as EnumContentCreationType: 1=Ecomm, 2=Editorial
pageNumber: number of the page (optional, start from 1, default=1)
pageSize: maximum number of item in output(optional, default=10, max=100)

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Clientid`	The identifier of the client whose tasks should be included.
`Contentcreationtypeid`	Filter tasks by the unique identifier of the content creation type.
`Productiontypeid`	The identifier of the production type to filter tasks by.
`Stepid`	The identifier of the step to filter tasks by.
`Status`	Filter tasks by their current status (e.g., pending, in progress, completed).
`Pagenumber`	String representing the page number of results to retrieve.
`Pagesize`	Specify the number of tasks to return per page for paginated results.
`Response Type`	The response format expected from the API (e.g. application/json).

/team-on-set

Description

Create a new team on set

Get the userId and skillId from GET v1/users/search

The returned teamOnSetId can be used in the API POST v1/capture/tasks/submit-assets

A teamOnSetId can be stored on the client side and reused (no timeout and no usage limit)

To avoid redundancy, we will return the same teamOnSetId if a request with the same list of users and skills is sent within 24 hours.

Validator

One user can only utilize one skill in a team

skillIds need to be valid according to the CF skills list

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/users/me

Request to retrieve user information about the current user (Useful to check the authentication is success or not).

Based on the token you are using:

For Authorization Code grant flow: The user who logged in will be returned.
For Client Credentials flow: The On-behalf user in the Developer Application Setting will be returned.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/team-on-set/{team-on-set-id}

Request to retrieve Team On Set information by teamOnSetId

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Team-on-set-id`	The identifier of the on-set team whose members are to be retrieved.
`Skillids`	Filter by multiple skillIds, separate by comma. When no filter skillIds, all skills will be returned
`Response Type`	The response format expected from the API (e.g. application/json).

/users/657722e1-82a0-4b33-b122-0331

Request to retrieve user information by UserId

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/users/search

Get users by their skills

keyword: string (optional) filter user by name or email.

skillIds: array int (optional) filter user by skills (EnumSkill).

pageNumber: number of the page (optional, start from 1, default=1).

pageSize: maximum number of item in output(optional, default=10, max=100).

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Pagenumber`	The page number for paginated results.
`Pagesize`	The number of results per page.
`Skillids`	An array of numeric skill identifiers to filter users by.

Data Sources (3)

E-Comm Production Requests (67)

Editorial Production Requests (17)

External Post-Production (14)

Files & Assets (5)

Logistics (22)

Query Parameters

Query Parameters

Master Data (4)

Planning (12)

Resource Users (5)

Task Lists

Users (5)