Objects

Media Object Information

Contains flows that references the media object and other information.

The paging query parameters and headers are required for the list of flow references in the media object. API implementations should return a complete list of flow references within reason and API clients should expect paging to happen in some rare cases where a media object is used in many flows.

get/objects/{objectId}

Path parameters

objectIdstring required

The media object identifier.

Query parameters

pagestring

Opaque string used by backend to access a specific page of results. Clients should read the next URL from the Link header returned with responses, or use value of the returned X-Paging-NextKey header. If not supplied, the first page is accessed. Implementations should ensure a consistent sort order is applied to pages of results.

limitinteger

Restrict the response to the specified number of results. Implementations may specify their own default and maximum for the limit

Response

idstring required

The media object identifier.

referenced_by_flowsstring[] required

List of Flows that reference this media object via Flow Segments in this store.

first_referenced_by_flowstring

The first Flow that had a Flow Segment reference the media object in this store. This Flow is also present in 'referenced_by_flows' if it is still referenced by the Flow. This property is optional and may in some implementations become unset if the Flow no longer references the media object, e.g. because it was deleted.

Changes