Operation Metadata Registration and Removal
This set of endpoints allows registering and removing metadata in an operation.
Operation Metadata Registration (POST)
Request
ENDPOINT
/commercial_paper/operation/OPERATION-KEY/metadataMETHOD
POSTPath Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
OPERATION-KEY * | string | Unique operation key (UUID v4). | 36 |
Request Body
{
"metadata_key": "custom_meta_field",
"metadata_value": "custom_meta_value"
}
Request Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
metadata_key * | string | Metadata key. | 255 |
metadata_value * | string | Metadata value. | 1023 |
Response
STATUS
201Response Body
{
"metadata_key": "custom_meta_field",
"metadata_value": "custom_meta_value"
}
Response Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
metadata_key * | string | Metadata key. | 255 |
metadata_value * | string | Metadata value. | 1023 |
Operation Metadata Removal (DELETE)
Request
ENDPOINT
/commercial_paper/operation/OPERATION-KEY/metadataMETHOD
DELETEPath Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
OPERATION-KEY * | string | Unique operation key (UUID v4). | 36 |
Request Body
{
"metadata_key": "custom_meta_field",
"metadata_value": "custom_meta_value"
}
Request Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
metadata_key * | string | Metadata key. | 255 |
metadata_value * | string | Metadata value. | 1023 |
Response
STATUS
204No content is returned in the response body.