v1

latestOpenAPI 3.1.0Apache 2.02026-07-178042197.1 KB
Service

Service Information

Provide information about the service.

get/service

Response

namestring

The service instance name. This should be a very short, human-readable name that may be displayed in listings of Service instances.

descriptionstring

The service instance description. This should be a human-readable description that may be showed in detailed views of Service instances. The description should be longer and more detailed than name.

typestring required

The type identifier for the service instance. The value must start with 'urn:x-tams:service'

api_versionstring required

The version of the TAMS API specification this service instance implements

service_versionstring

The version of software providing this service. Note: Different implementations and software houses may use different conventions for their version identification. As such, this field is intentionally permissive and intended to be informative only. Client implementations should avoid using this field to determine compatibility.

min_object_timeoutstring required

A signed nanosecond resolution timestamp represented as "{sign?}{seconds}:{nanoseconds}". The intended interpretation of the value is assumed to be defined elsewhere.

E.g.

  • "1:40000000" is the timestamp of the 27th video frame for 25 Hz video with origin at "0:0".
  • "1694429247:40000000" is the TAI timestamp for a video frame at 2023-09-11T10:46:50.04Z UTC.

Details of the format can be found in the Timestamps in TAMS application note.

min_presigned_url_timeoutstring

A signed nanosecond resolution timestamp represented as "{sign?}{seconds}:{nanoseconds}". The intended interpretation of the value is assumed to be defined elsewhere.

E.g.

  • "1:40000000" is the timestamp of the 27th video frame for 25 Hz video with origin at "0:0".
  • "1694429247:40000000" is the TAI timestamp for a video frame at 2023-09-11T10:46:50.04Z UTC.

Details of the format can be found in the Timestamps in TAMS application note.