Person API

From TeamServer ER/Studio
Jump to: navigation, search

Go Up to API Reference

You cannot access people information directly through the API, but some of the APIs provide information about person resources.

Person Fields

Person resources may provide the following fields:

Item Example Description

"id"

"2"

An integer that uniquely identifies the person.

"name"

"jane"

The username of the person.

"url"

"/v1/people/2"

Path relative to the ER/Studio Team Server root API URL that points to the entry of the person resource.

For example, if the ER/Studio Team Server root API URL is http://teamserver.example.com/api, the example value here determines that you can access the person resource at http://teamserver.example.com/api/v1/people/2.

"type"

"person"

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