Skip to main content

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/metadata
METHOD
POST

Path Params

FieldTypeDescriptionMax Characters
OPERATION-KEY *stringUnique operation key (UUID v4).36
Request Body
{
"metadata_key": "custom_meta_field",
"metadata_value": "custom_meta_value"
}

Request Body Params

FieldTypeDescriptionMax Characters
metadata_key *stringMetadata key.255
metadata_value *stringMetadata value.1023

Response

STATUS
201
Response Body
{
"metadata_key": "custom_meta_field",
"metadata_value": "custom_meta_value"
}

Response Body Params

FieldTypeDescriptionMax Characters
metadata_key *stringMetadata key.255
metadata_value *stringMetadata value.1023

Operation Metadata Removal (DELETE)

Request

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/metadata
METHOD
DELETE

Path Params

FieldTypeDescriptionMax Characters
OPERATION-KEY *stringUnique operation key (UUID v4).36
Request Body
{
"metadata_key": "custom_meta_field",
"metadata_value": "custom_meta_value"
}

Request Body Params

FieldTypeDescriptionMax Characters
metadata_key *stringMetadata key.255
metadata_value *stringMetadata value.1023

Response

STATUS
204

No content is returned in the response body.