Skip to content

Limited
Share processing aid

Request

Grants access to this processing aid.

Always grants access to the company that owns the processing aid, taken from the processing aid itself, never from the caller. A processing aid created through this API is visible to nobody until it is shared, so this is how its owner first sees it.

List companyIds to grant access to other companies as well, typically a retailer. No body and an empty list both grant the owner only.

Idempotent: a company that already has access is left as it is.

Security
oauth2(Required scopes: t1_api)
Path
materialIdstring, (uuid)required

The unique identifier of the material

Bodyapplication/json
companyIdsArray of strings, (uuid)

Companies to grant access to IN ADDITION to the owner company, which every share grants. Absent or empty = the owner only. All of them are granted or none is: an unknown id is refused naming the field, and nothing is written before the refusal.

curl -i -X POST \
  'https://apis.traceone.com/spec/v2/library/materials/processing-aids/{materialId}/share' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

The processing aid was shared

Response
No content