Get Session Context

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (SessionContext)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

SessionContext

Example:

SessionContext

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "SessionContext",
        "attributes": {
            "locale": "string",
            "caslPolicies": [
                [
                    {
                        "group": "string",
                        "subject": "string",
                        "actions": "create",
                        "conditions": {}
                    }
                ]
            ],
            "isPortalOwner": true,
            "intercomHash": "string",
            "apiHostname": "string",
            "region": "eu-west-1",
            "regionalApiUrl": "https://use1.prod.api.synap.ac"
        },
        "relationships": {
            "user": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "userType": {
                "data": {
                    "id": "FID001",
                    "type": "UserType"
                }
            },
            "studyType": {
                "data": {
                    "id": "FID001",
                    "type": "UserType"
                }
            },
            "pinnedNotes": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "Note"
                    }
                ]
            },
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            }
        }
    },
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ]
}

🟠404Record Not Found

Request

Request samples

Responses