Glossary API

From TeamServer ER/Studio
Jump to: navigation, search

Go Up to API Reference

This part of the Team Server API lets you work with glossaries.

GET v1/businessglossaries

Obtains a list of glossaries.

If successful, the response from the server provides a list of glossaries with details about each one of them.

GET v1/businessglossaries/<id>

Obtains information about the glossary with the specified ID.

POST v1/businessglossaries

Creates a glossary. Your request must provide the following fields:

  • name
  • description (optional)
  • status (optional)
  • stewards (optional)
    Note: You only need to specify either the ID or the name of each steward. For example: { "name": "jane" }

If successful, the response from the server provides all the details about your new glossary.

PUT v1/businessglossaries/<id>

Updates the information of a glossary. Your request can provide any combination of the following fields:

  • name
  • description
  • status
  • stewards
    Note: You only need to specify either the ID or the name of each steward. For example: { "name": "jane" }

If successful, the response from the server provides all the details about your modified glossary.

DELETE v1/businessglossaries/<id>

Deletes the glossary with the specified ID. If successful, the response is {"message":"OK","status":"200"}.

Glossary Fields

Glossary resources in Glossary API requests and responses may include any combination of the following fields:

Item Example Description

"id"

18

An integer that uniquely identifies the glossary.

"status"

"In progress"

A string that defines the status of the glossary using nomenclature you decide upon.

"description"

"Systems of rules for message exchange within or between computers."

A description of the glossary.

"link"

"/glossary/view.spg?glossaryKey=18"

Path relative to the Team Server root URL that points to the page of the glossary.

For example, if the Team Server root URL is http://teamserver.example.com , the example value here determines that you can access the page of the glossary at http://teamserver.example.com/glossary/view.spg?glossaryKey=18 .

"name"

"Network Protocols"

The name of the glossary.

"type"

"Glossary"

The type of the resource. Its value is always "Glossary" for glossary resources.

"stewards"

[
    {
        "id": "2",
        "name": "jane",
        "type": "person",
        "url": "/v1/people/2"
    },
    // …
]

A list of people that are stewards of the glossary.

Each person entry provides the following fields:

  • id
  • name
  • type
  • url

"url"

"/v1/businessglossaries/18"

Path relative to the Team Server root API URL that points to the entry of the glossary resource.

For example, if the Team Server root API URL is http://teamserver.example.com/api , the example value here determines that you can access the glossary resource at http://teamserver.example.com/api/v1/businessglossaries/18 .

"CreatedAt"

"1372150068"

The Glossary creation date in Unix time. Possible from a GET command.

"ModifiedAt"

"1372150068"

The Glossary latest modified date in Unix time. Possible from a GET command.

Example Response

This is an example response from a GET v1/businessglossaries call:

{
    "businessglossaries": [
        {
            "id": 18,
            "status": "In progress",
            "description": "Systems of rules for message exchange within or between computers.",
            "link": "/glossary/view.spg?glossaryKey=18",
            "name": "Network Protocols",
            "type": "Glossary",
            "stewards": [
                {
                    "id": "2",
                    "name": "jane",
                    "type": "person",
                    "url": "/v1/people/2"
                }
            ],
            "url": "/v1/businessglossaries/18"
        },
        {
            "id": 19,
            "status": "In progress",
            "description": "Methods by which voters make a choice between options.",
            "link": "/glossary/view.spg?glossaryKey=19",
            "name": "Voting Systems",
            "type": "Glossary",
            "stewards": [
                {
                    "id": "2",
                    "name": "jane",
                    "type": "person",
                    "url": "/v1/people/2"
                }
            ],
            "url": "/v1/businessglossaries/19"
        }
    ],
    "metadata_": {
        "limit": 25,
        "totalCount": 2,
        "offset": 0
    }
}

This is from a GET v1/businessglossaries/<id> call:

{
    "businessglossary": {
        "id": 18,
        "status": "In progress",
        "description": "Systems of rules for message exchange within or between computers.",
        "link": "/glossary/view.spg?glossaryKey=18",
        "name": "Network Protocols",
        "type": "Glossary",
        "stewards": [
            {
                "id": "2",
                "name": "jane",
                "type": "person",
                "url": "/v1/people/2"
            }
        ],
        "url": "/v1/businessglossaries/18"
    }
}

See Also

Personal tools
Product Videos