Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Fetch terms

Endpoint ID:2100
Method:

GET

URL:

/permissions/terms/{termsID}


termsIDOPTIONAL: A GUID string identifier for the terms
Request body:None

Response body:

JSON data with information about terms.

/permissions/terms – Two terms exists
{
    "terms": [
        {
            "id": "7a6776a3-9411-4d34-9866-99aa9ac7cc27",
            "name": "Some terms",
            "description": "This explains everything",
            "versions": [
                {
                    "version": "1.0",
                    "state": "draft"
                }
            ]
        },
        {
            "id": "1f788c79-7dde-407f-a976-6b08ffb4c75a",
            "name": "Some other terms",
            "description": "This explains these terms",
            "versions": [
                {
                    "version": "2.0",
                    "state": "active"
                },
                {
                    "version": "1.0",
                    "state": "obsolete"
                }
            ]
        }
    ]
}
/terms/permission – No terms exists
{
    "terms": []
}

When a termsID parameter is included in the request, an empty terms array will never be returned - either the requested terms object will be returned, or a 404 response.

/permissions/terms/7a6776a3-9411-4d34-9866-99aa9ac7cc27 – Specific terms found
{
    "terms": [
        {
            "id": "7a6776a3-9411-4d34-9866-99aa9ac7cc27",
            "name": "Some terms",
            "description": "This explains everything",
            "versions": [
                {
                    "version": "1.0",
                    "state": "draft"
                }
            ]
        }
    ]
}


Status codes:200OK

404Terms not found - only returned when a termsID parameter is included in the request

  • No labels