Get organizations of a capacity area

get

/rest/ofscMetadata/v1/capacityAreas/{label}/organizations

This operation retrieves a collection of organizations for the specified capacity area.

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 255
    The label of the capacity area.
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : AreaOrganizations
Type: object
The collection of organizations.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : AreaOrganization
Type: object
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to get organizations for a specific capacity area by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET/rest/ofscMetadata/v1/capacityAreas/CapacityArea/organizations
Connection: close
Accept-Encoding: gzip,deflate
Authorization: Basic bXlyb290QHFhNTUwMzox
Host: <instance_name>.etadirect.com
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 23 Aug 2017 15:01:16 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Credentials: true
Strict-Transport-Security: max-age=31536000; includeSubDomains;

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "label": "default",
            "name": "Sunrise Enterprise",
            "type": "inhouse"
        }
    ]
}
Back to Top