Date: Thu, 28 Mar 2024 19:01:05 +0000 (UTC) Message-ID: <1657692477.9341.1711652465651@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_9340_1587452718.1711652465640" ------=_Part_9340_1587452718.1711652465640 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Organisations (collection) resource
Root Relation: Organisations
This resource supports the following methods: GET, POST
Retrieves a list of all organisations.
This method supports the OData parameters $filter, $top, $take, $orderby= and $inlinecount. See = OData Topic for more details.
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
Retrieves all organisations.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "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-c9= 37338b0e31" } ] }
Status Code
200 - OK
Create a new organisation.
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
201 - Created | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if request can not be satisified (inval= id values, or insufficient permissions). |
Creates a new organisation (if your license allows it)
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Body
{ "Name": "Acme Inc", "ShortDescription": "Acme Inc make products", "LongDescription": "Acme Inc make products large and small, for many vert= icals and horizontals", "IndustryType": "Generics" }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 | |
Location | http://localhost/api/organisation/A84DE3D2= -6B49-41C4-AD1D-C937338B0E31 |
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 vert= icals 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-c93733= 8b0e31" }
Status Code
201 - Created