Jump to

• Request
• Response
• Examples

Get capacity categories of a capacity area

get

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

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

Request

Path Parameters

• label(required): string
  Minimum Length: 1

  Maximum Length: 255

  The label of the capacity area.

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : AreaCapacityCategories

Type: object

The collection of capacity categories.

Show Source

• items: array items

{
    "description":"The collection of capacity categories.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AreaCapacityCategory"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object AreaCapacityCategory

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AreaCapacityCategory"
    }
}

Nested Schema : AreaCapacityCategory

Type: object

Show Source

• label: string
  The label of the capacity category.
• name: string
  The name of the capacity category in the user's language.
• status: string
  Allowed Values: [ "active", "inactive" ]

  The status of the capacity category.

{
    "properties":{
        "label":{
            "description":"The label of the capacity category.",
            "type":"string"
        },
        "name":{
            "description":"The name of the capacity category in the user's language.",
            "type":"string"
        },
        "status":{
            "description":"The status of the capacity category.",
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ]
        }
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to get capacity categories 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/capacityCategories
Connection: close
Accept-Encoding: gzip,deflate
Authorization: Basic bXlyb290QHFhNTUwMzox
Host: <instance_name>.fs.ocs.oraclecloud.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": "IN",
            "name": "Install",
            "status": "active"
        },
        {
            "label": "TC",
            "name": "Trouble Call",
            "status": "active"
        },
        {
            "label": "DI",
            "name": "Deinstall",
            "status": "active"
        }
    ]
}

Back to Top