Get Started
Studio API
- Introduction
- Streaming
- CMS
- Events
- Creative Works
- Entities
- Content Types
- Annotations
- OTT
- Monetization
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
Get entity
GetEntity
Returns entity information by entity ID.
curl --request GET \
--url https://api.mottostreaming.com/cms/entities/v1/{entity_id} \
--header 'Authorization: Bearer <token>'{
"entity": {
"id": "<string>",
"project_id": "<string>",
"type_id": "<string>",
"name": "<string>",
"description": "<string>",
"thumbnail_asset_id": "<string>",
"disabled": true,
"fields": {},
"visibility": "VISIBILITY_UNSPECIFIED",
"create_time": "2023-11-07T05:31:56Z",
"localized_name": {},
"localized_description": {},
"localized_thumbnail_asset_id": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Entity represents some object, such as competition, conference, team or person.
System generated unique identifier for the entity.
The type id of the entity. For example competition. May be set to default when no custom fields are present.
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN A map of localized names for this entity, for end users to see. The key is the language code (ISO 639 - set 1) (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2) e.g. "en-US", "en-GB", etc.
Leaving this field empty will default to the name field.
A map of localized descriptions for this entity. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.
Leaving this field empty will default to the description field.
A map of localized thumbnail asset IDs for this entity. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.
Leaving this field empty will default to the thumbnail_asset_id field.
curl --request GET \
--url https://api.mottostreaming.com/cms/entities/v1/{entity_id} \
--header 'Authorization: Bearer <token>'{
"entity": {
"id": "<string>",
"project_id": "<string>",
"type_id": "<string>",
"name": "<string>",
"description": "<string>",
"thumbnail_asset_id": "<string>",
"disabled": true,
"fields": {},
"visibility": "VISIBILITY_UNSPECIFIED",
"create_time": "2023-11-07T05:31:56Z",
"localized_name": {},
"localized_description": {},
"localized_thumbnail_asset_id": {}
}
}