Resource: Organisations ( /api/organisations )
Organisations (collection) resource
Root Relation: Organisations
This resource supports the following methods: GET, POST
Methods
GET
Retrieves a list of all organisations.
This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.
Supported Expansions
- RelationshipTypes
- Projects
- ProjectCategories
- Statuses
- Priorities
- RequirementTypes
- RequirementStatuses
- RequirementDifficulties
- IncidentTypes
- TestTypes
- IncidentResolutions
- IncidentStatuses
- Versions
- Components
For more details on expansions, please see the Expand help topic.
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
Retrieves all organisations.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Items": [
{
"Id": "a84de3d2-6b49-41c4-ad1d-c937338b0e31",
"Name": "Acme Inc",
"OrderNumber": 1,
"ShortDescription": "Acme Inc make products",
"LongDescription": "Acme Inc make products large and small, for many verticals and horizontals",
"IndustryType": "Generics",
"Expands": [
"Components",
"IncidentResolutions",
"IncidentStatuses",
"IncidentTypes",
"Priorities",
"ProjectCategories",
"Projects",
"RequirementDifficulties",
"RequirementStatuses",
"RequirementTypes",
"Statuses",
"TestTypes",
"Versions"
],
"Self": "http://localhost/api/organisation/a84de3d2-6b49-41c4-ad1d-c937338b0e31"
}
]
}
|
Status Code
200 - OK
POST
Create a new organisation.
Required Permissions
- Administration/Organisation/ManageOrganisation
Supported Expansions
- RelationshipTypes
- Projects
- ProjectCategories
- Statuses
- Priorities
- RequirementTypes
- RequirementStatuses
- RequirementDifficulties
- IncidentTypes
- TestTypes
- IncidentResolutions
- IncidentStatuses
- Versions
- Components
For more details on expansions, please see the Expand help topic.
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 201 - Created | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if request can not be satisified (invalid values, or insufficient permissions). |
Creates a new organisation (if your license allows it)
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Body
| Code Block | ||
|---|---|---|
| ||
{
"Name": "Acme Inc",
"ShortDescription": "Acme Inc make products",
"LongDescription": "Acme Inc make products large and small, for many verticals and horizontals",
"IndustryType": "Generics"
}
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 | |
| Location | http://localhost/api/organisation/A84DE3D2-6B49-41C4-AD1D-C937338B0E31 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Id": "a84de3d2-6b49-41c4-ad1d-c937338b0e31",
"Name": "Acme Inc",
"OrderNumber": 1,
"ShortDescription": "Acme Inc make products",
"LongDescription": "Acme Inc make products large and small, for many verticals and horizontals",
"IndustryType": "Generics",
"Expands": [
"Components",
"IncidentResolutions",
"IncidentStatuses",
"IncidentTypes",
"Priorities",
"ProjectCategories",
"Projects",
"RequirementDifficulties",
"RequirementStatuses",
"RequirementTypes",
"Statuses",
"TestTypes",
"Versions"
],
"Self": "http://localhost/api/organisation/a84de3d2-6b49-41c4-ad1d-c937338b0e31"
}
|
Status Code
201 - Created