Organisation (Resources)
Resource: Organisation ( /api/organisation/{id} )
Resource representing a single organisation. Currently Enterprise Tester only supports a single organisation, so the unique orgranisation identifier can be omitted to return the default project when interacting with this resource.
This resource supports the following methods: DELETE, GET, PUT
Methods
DELETE
Start a background task to delete a organisation
Required Permissions
Administration/Organisation/ManageOrganisation
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 |
|---|---|
202 - Accepted | Returned if the task was started successfully. |
404 - NotFound | Returned if project was not found. |
GET
Retrieves information about a single organisation.
Supported Expansions
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. |
404 - NotFound | Returned if organisation was not found. |
Example - Get organisation by ID
Retrieve organisation identified by its unique identifier.
Request Headers
Key | Value | Description |
|---|---|---|
Accept | application/json |
|
Request Parameters
Key | Value | Description |
|---|---|---|
{id} | A84DE3D2-6B49-41C4-AD1D-C937338B0E31 | Unique identifier of organisation. |
Response Headers
Key | Value | Description |
|---|---|---|
Content-Type | application/json; charset=utf-8 |
|
Response Body
{
"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
Example - Get default organisation
Retrieves the default organisation by omitting any unique identifier (Currently all Enterprise Tester installations have a maximum of 1 organisation, so this will return the only organisation).
Request Headers
Key | Value | Description |
|---|---|---|
Accept | application/json |
|
Response Headers
Key | Value | Description |
|---|---|---|
Content-Type | application/json; charset=utf-8 |
|
Response Body
{
"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
PUT
Update details for an organisation.
Required Permissions
Administration/Organisation/ManageOrganisation
Supported Expansions
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. |
403 - Forbidden | Returned if request can not be satisified (invalid values, or insufficient permissions). |
404 - NotFound | Returned if organisation was not found. |
Example - Update organisation details
Update organisation details.
Request Headers
Key | Value | Description |
|---|---|---|
Accept | application/json |
|
Request Body
{
"Name": "XYZ Corp",
"OrderNumber": 2,
"ShortDescription": "XYZ Corp integrate systems",
"LongDescription": "XYZ Corp can integrate any X with any Y to make a Z",
"IndustryType": "Integration"
}
Response Headers
Key | Value | Description |
|---|---|---|
Content-Type | application/json; charset=utf-8 |
|
Response Body
{
"Id": "a84de3d2-6b49-41c4-ad1d-c937338b0e31",
"Name": "XYZ Corp",
"OrderNumber": 2,
"ShortDescription": "XYZ Corp integrate systems",
"LongDescription": "XYZ Corp can integrate any X with any Y to make a Z",
"IndustryType": "Integration",
"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