/api/v1/item/lifecycle

POST

const url = 'https://dpg.example.com/api/v1/item/lifecycle';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: '{"item_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","action":"pause"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dpg.example.com/api/v1/item/lifecycle \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "action": "pause" }'

Authorizations

apiKeyAuth
sessionAuth

Request Body^required

application/json

object

item_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

action

required

string

Allowed values: pause unpause

Responses

200

Default Response

application/json

object

item_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

lifecycle_status

required

string

Allowed values: draft live paused

Example

{
  "lifecycle_status": "draft"
}

/api/v1/item/lifecycle

Authorizations

Request Bodyrequired

Responses

200

Example

Request Body^required