Skip to main content

Get a List of Session Metadata

Gets a list of metadata for the specified session.

Authorizations: Sessions - VIEW

Requests

GET /apis/sessions/:sessionId/metadata

Response

Success

{
"data": [
  {
    "name": "calypso:creator",
    "field": [
      {
        "fieldType": "STRING",
        "valueString": "creator"
      }
    ]
  },
  {
    "name": "calypso:recording",
    "field": [
      {
        "fieldType": "STRING",
        "valueString": "0a354588-b4d1-4f72-acb1- bbcdd3fa75ff"
      }
    ]
  },
  {
    "name": "calypso:creatorDisplayName",
    "field": [
      {
        "fieldType": "STRING",
        "valueString": "haiadmin"
      }
    ]
  }
]
}

Parameters

Property

JSON Type

Property Type

Description

name

String

Required

Name of metadata.

field

Array of objects (fields) for these possible structures:

{ "fieldType": "STRING",
"valueString": "value" }
{ "fieldType": "INT32",
"valueInt32": -14 }
{ "fieldType": "UINT32",
"valueUint32": 42 }

Required

Content of metadata. See Fields.

Error

Code

Payload

 Description

404
{"code":"040012", "name":"NoResults",
"message":"No results", "httpStatusCode": 404}

The specified session has no metadata.

404
{"code":"040006", "name":"SessionNotFound",
"message":"Session not found", "httpStatusCode":404}

Session with UUID sessionId not found.

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.