CustomMetadataSet

Get All Custom Metadata Sets GET /custommetadatasets/

Description

Request all custom metadata sets.

Properties

Title

Get all custom metadata sets

URL

/custommetadatasets/

Method

GET

Headers

Name	Value	Required	Description
Authorization	Token xxxxx	yes	Authorization token required to communicate with the API.

URL Params

Name	Type	Required	Description
limit	integer	no	Limit the number of objects to return.
offset	integer	no	Do not return the first x objects, where x is the amount specified by offset.

Success Response

200 - OK

[
  {
    "id": 1,
    "name": "My custom metadata set",
    "description": "A metadata set for video assets.",
    "content_type": 24
  },
  ...
]

Sample Call

curl -X GET http://medialoopster-url/api/custommetadatasets/

Get Single Custom Metadata Set GET /custommetadatasets/{id}/

Description

Request a single custom metadata set.

Properties

Title

Get single custom metadata field

URL

/custommetadatasets/{id}/

Method

GET

Headers

Name	Value	Required	Description
Authorization	Token xxxxx	yes	Authorization token required to communicate with the API.

Success Response

200 - OK

{
  "id": 1,
  "name": "My custom metadata set",
  "description": "A metadata set for video assets.",
  "content_type": 24
}

Error Response

404 - Not Found

{
  "errors": [
    {
      "status": "404",
      "code": "not_found",
      "detail": "CustomMetadataSet object with pk=u'{id}' does not exist.",
      "title": "Not Found"
    }
  ]
}

Sample Call

curl -X GET http://medialoopster-url/api/custommetadatasets/1/

Create Custom Metadata SetPOST /custommetadatasets/

Description

Create a new custom metadata set.

Properties

Title

Create custom metadata set

URL

/custommetadatasets/

Method

POST

Headers

Name	Value	Required	Description
Authorization	Token xxxxx	yes	Authorization token required to communicate with the API.
Content-Type	application/json	no	If the request body is sent as raw data instead of form-data this header needs to be set as well.

Data Params

Name	Type	Required	Description
name	string	yes	A name for the custom metadata set.
description	string	yes	A description of the custom metadata set.
content_type	number	yes	ID of the content type to attach this custom metadata set to.

Success Response

201 - Created

Error Response

400 - Bad Request

{
  "errors": [
    {
      "status": "400",
      "source": {
        "pointer": "/name"
      },
      "code": "required",
      "detail": "Dieses Feld ist erforderlich.",
      "title": "Validation Error"
    },
    {
      "status": "400",
      "source": {
        "pointer": "/content_type"
      },
      "code": "required",
      "detail": "Dieses Feld ist erforderlich.",
      "title": "Validation Error"
    },
    {
      "status": "400",
      "source": {
        "pointer": "/description"
      },
      "code": "required",
      "detail": "Dieses Feld ist erforderlich.",
      "title": "Validation Error"
    }
  ]
}

Sample Call

curl -X POST http://medialoopster-url/api/custommetadatasets/ \
  -d '{
    "name": "Video Metadata",
    "description": "Custom metadata set for video assets.",
    "content_type": 24
  }'