Jump to

• Request
• Response
• Examples

Get a capacity area

get

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

This operation retrieves details about 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 : CapacityAreaConfiguration

Type: object

The schema of the capacity area object.

Show Source

• capacityCategories: object capacityCategories
  The capacity categories assigned to the capacity area. The capacity categories are not retrieved for a capacity area group.
• children: object children
  The capacity areas assigned to the capacity area group. The child capacity areas are always returned for a capacity area group.
• configuration: object configuration
  The configuration of the capacity area.
• label: string
  The label of the capacity area.
• name: string
  The name of the capacity area in the user's language.
• organizations: object organizations
  The organizations assigned to the capacity area. The organizations are not retrieved for a capacity area group.
• parentLabel: string
  The label of the parent group.
• status: string
  Allowed Values: [ "active", "inactive" ]

  The status of the capacity area.
• timeIntervals: object timeIntervals
  The time intervals assigned to the capacity area. The time intervals are not retrieved for a capacity area group.
• timeSlots: object timeSlots
  The time slots assigned to the capacity area. The time slots are not retrieved for a capacity area group.
• type: string
  Allowed Values: [ "group", "area" ]
• workZones: object workZones
  The work zones assigned to the capacity area. The work zones are not retrieved for a capacity area group.

{
    "description":"The schema of the capacity area object.",
    "properties":{
        "label":{
            "description":"The label of the capacity area.",
            "type":"string"
        },
        "name":{
            "description":"The name of the capacity area in the user's language.",
            "type":"string"
        },
        "parentLabel":{
            "description":"The label of the parent group.",
            "type":"string"
        },
        "status":{
            "description":"The status of the capacity area.",
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ]
        },
        "type":{
            "type":"string",
            "enum":[
                "group",
                "area"
            ]
        },
        "configuration":{
            "description":"The configuration of the capacity area.",
            "type":"object",
            "properties":{
                "definitionLevel":{
                    "description":"The definition level set for the quota.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "byDay":{
                    "description":"The configuration defined for the capacity area determines how quota is entered for a day.<ul><li>minutes: Indicates that the quota is entered in minutes</li><li>percentIncludeOtherActivities: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar. The maximum available capacity considers the capacity of the 'Other' activities.</li><li>percentExcludeOtherActivities: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar. The maximum available capacity considers the capacity of the 'Other' activities.</li></ul>",
                    "type":"string",
                    "enum":[
                        "minutes",
                        "percentIncludeOtherActivities",
                        "percentExcludeOtherActivities"
                    ]
                },
                "byCapacityCategory":{
                    "description":"The configuration defined for the capacity area determines how quota is entered for the capacity category.<ul><li>minutes: Indicates that the quota is entered in minutes.</li><li>percentOfMaxAvailable: Indicates that the quota is entered as a percentage of the maximum available capacity.</li><li>percentQuotaParentLevel: Indicates that the quota is entered as a percentage of the quota defined on the parent level.</li></ul>",
                    "type":"string",
                    "enum":[
                        "minutes",
                        "percentOfMaxAvailable",
                        "percentQuotaParentLevel"
                    ]
                },
                "byTimeSlot":{
                    "description":"The configuration defined for the capacity area determines how quota is entered for a timeslot.<ul><li>minutes: Indicates that the quota is entered in minutes</li><li>percentOfAvailable: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar.</li><li>percentExcludeOtherActivities: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar. The maximum available capacity considers the capacity of the 'Other' activities.</li><li>percentQuotaParentLevel: Indicates that the quota is entered as a percentage of the quota defined on the parent level.</li></ul>",
                    "type":"string",
                    "enum":[
                        "minutes",
                        "percentOfAvailable",
                        "percentExcludeOtherActivities",
                        "percentQuotaParentLevel"
                    ]
                },
                "isTimeSlotBase":{
                    "description":"Contains one of the following values: true or false. If true, then the time slot based quota is available for the capacity area. If false, then only the time interval based quota is available for the capacity area. The default value is false.",
                    "type":"boolean"
                },
                "isAllowCloseOnWorkzoneLevel":{
                    "description":"Contains one of the following values: true or false. If true, then the quota is closed for the workzone. If false, then the quota is open for the workzone. The default value is false.",
                    "type":"boolean"
                }
            }
        },
        "capacityCategories":{
            "description":"The capacity categories assigned to the capacity area. The capacity categories are not retrieved for a capacity area group.",
            "type":"object",
            "properties":{
                "href":{
                    "description":"The link to the capacity category collection.",
                    "type":"string"
                }
            }
        },
        "timeSlots":{
            "description":"The time slots assigned to the capacity area. The time slots are not retrieved for a capacity area group.",
            "type":"object",
            "properties":{
                "href":{
                    "description":"The link to the time slot collection.",
                    "type":"string"
                }
            }
        },
        "workZones":{
            "description":"The work zones assigned to the capacity area. The work zones are not retrieved for a capacity area group.",
            "type":"object",
            "properties":{
                "href":{
                    "description":"The link to the work zone collection.",
                    "type":"string"
                }
            }
        },
        "timeIntervals":{
            "description":"The time intervals assigned to the capacity area. The time intervals are not retrieved for a capacity area group.",
            "type":"object",
            "properties":{
                "href":{
                    "description":"The link to the time interval collection.",
                    "type":"string"
                }
            }
        },
        "organizations":{
            "description":"The organizations assigned to the capacity area. The organizations are not retrieved for a capacity area group.",
            "type":"object",
            "properties":{
                "href":{
                    "description":"The link to the organization collection.",
                    "type":"string"
                }
            }
        },
        "children":{
            "description":"The capacity areas assigned to the capacity area group. The child capacity areas are always returned for a capacity area group.",
            "type":"object",
            "properties":{
                "href":{
                    "description":"The link to the capacity area collection.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : capacityCategories

Type: object

The capacity categories assigned to the capacity area. The capacity categories are not retrieved for a capacity area group.

Show Source

• href: string
  The link to the capacity category collection.

{
    "description":"The capacity categories assigned to the capacity area. The capacity categories are not retrieved for a capacity area group.",
    "type":"object",
    "properties":{
        "href":{
            "description":"The link to the capacity category collection.",
            "type":"string"
        }
    }
}

Nested Schema : children

Type: object

The capacity areas assigned to the capacity area group. The child capacity areas are always returned for a capacity area group.

Show Source

• href: string
  The link to the capacity area collection.

{
    "description":"The capacity areas assigned to the capacity area group. The child capacity areas are always returned for a capacity area group.",
    "type":"object",
    "properties":{
        "href":{
            "description":"The link to the capacity area collection.",
            "type":"string"
        }
    }
}

Nested Schema : configuration

Type: object

The configuration of the capacity area.

Show Source

• byCapacityCategory: string
  Allowed Values: [ "minutes", "percentOfMaxAvailable", "percentQuotaParentLevel" ]

  The configuration defined for the capacity area determines how quota is entered for the capacity category.

  • minutes: Indicates that the quota is entered in minutes.
  • percentOfMaxAvailable: Indicates that the quota is entered as a percentage of the maximum available capacity.
  • percentQuotaParentLevel: Indicates that the quota is entered as a percentage of the quota defined on the parent level.
• byDay: string
  Allowed Values: [ "minutes", "percentIncludeOtherActivities", "percentExcludeOtherActivities" ]

  The configuration defined for the capacity area determines how quota is entered for a day.

  • minutes: Indicates that the quota is entered in minutes
  • percentIncludeOtherActivities: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar. The maximum available capacity considers the capacity of the 'Other' activities.
  • percentExcludeOtherActivities: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar. The maximum available capacity considers the capacity of the 'Other' activities.
• byTimeSlot: string
  Allowed Values: [ "minutes", "percentOfAvailable", "percentExcludeOtherActivities", "percentQuotaParentLevel" ]

  The configuration defined for the capacity area determines how quota is entered for a timeslot.

  • minutes: Indicates that the quota is entered in minutes
  • percentOfAvailable: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar.
  • percentExcludeOtherActivities: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar. The maximum available capacity considers the capacity of the 'Other' activities.
  • percentQuotaParentLevel: Indicates that the quota is entered as a percentage of the quota defined on the parent level.
• definitionLevel: array definitionLevel
  The definition level set for the quota.
• isAllowCloseOnWorkzoneLevel: boolean
  Contains one of the following values: true or false. If true, then the quota is closed for the workzone. If false, then the quota is open for the workzone. The default value is false.
• isTimeSlotBase: boolean
  Contains one of the following values: true or false. If true, then the time slot based quota is available for the capacity area. If false, then only the time interval based quota is available for the capacity area. The default value is false.

{
    "description":"The configuration of the capacity area.",
    "type":"object",
    "properties":{
        "definitionLevel":{
            "description":"The definition level set for the quota.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "byDay":{
            "description":"The configuration defined for the capacity area determines how quota is entered for a day.<ul><li>minutes: Indicates that the quota is entered in minutes</li><li>percentIncludeOtherActivities: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar. The maximum available capacity considers the capacity of the 'Other' activities.</li><li>percentExcludeOtherActivities: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar. The maximum available capacity considers the capacity of the 'Other' activities.</li></ul>",
            "type":"string",
            "enum":[
                "minutes",
                "percentIncludeOtherActivities",
                "percentExcludeOtherActivities"
            ]
        },
        "byCapacityCategory":{
            "description":"The configuration defined for the capacity area determines how quota is entered for the capacity category.<ul><li>minutes: Indicates that the quota is entered in minutes.</li><li>percentOfMaxAvailable: Indicates that the quota is entered as a percentage of the maximum available capacity.</li><li>percentQuotaParentLevel: Indicates that the quota is entered as a percentage of the quota defined on the parent level.</li></ul>",
            "type":"string",
            "enum":[
                "minutes",
                "percentOfMaxAvailable",
                "percentQuotaParentLevel"
            ]
        },
        "byTimeSlot":{
            "description":"The configuration defined for the capacity area determines how quota is entered for a timeslot.<ul><li>minutes: Indicates that the quota is entered in minutes</li><li>percentOfAvailable: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar.</li><li>percentExcludeOtherActivities: Indicates that the quota is entered as a percentage of the maximum available capacity according to the calendar. The maximum available capacity considers the capacity of the 'Other' activities.</li><li>percentQuotaParentLevel: Indicates that the quota is entered as a percentage of the quota defined on the parent level.</li></ul>",
            "type":"string",
            "enum":[
                "minutes",
                "percentOfAvailable",
                "percentExcludeOtherActivities",
                "percentQuotaParentLevel"
            ]
        },
        "isTimeSlotBase":{
            "description":"Contains one of the following values: true or false. If true, then the time slot based quota is available for the capacity area. If false, then only the time interval based quota is available for the capacity area. The default value is false.",
            "type":"boolean"
        },
        "isAllowCloseOnWorkzoneLevel":{
            "description":"Contains one of the following values: true or false. If true, then the quota is closed for the workzone. If false, then the quota is open for the workzone. The default value is false.",
            "type":"boolean"
        }
    }
}

Nested Schema : organizations

Type: object

The organizations assigned to the capacity area. The organizations are not retrieved for a capacity area group.

Show Source

• href: string
  The link to the organization collection.

{
    "description":"The organizations assigned to the capacity area. The organizations are not retrieved for a capacity area group.",
    "type":"object",
    "properties":{
        "href":{
            "description":"The link to the organization collection.",
            "type":"string"
        }
    }
}

Nested Schema : timeIntervals

Type: object

The time intervals assigned to the capacity area. The time intervals are not retrieved for a capacity area group.

Show Source

• href: string
  The link to the time interval collection.

{
    "description":"The time intervals assigned to the capacity area. The time intervals are not retrieved for a capacity area group.",
    "type":"object",
    "properties":{
        "href":{
            "description":"The link to the time interval collection.",
            "type":"string"
        }
    }
}

Nested Schema : timeSlots

Type: object

The time slots assigned to the capacity area. The time slots are not retrieved for a capacity area group.

Show Source

• href: string
  The link to the time slot collection.

{
    "description":"The time slots assigned to the capacity area. The time slots are not retrieved for a capacity area group.",
    "type":"object",
    "properties":{
        "href":{
            "description":"The link to the time slot collection.",
            "type":"string"
        }
    }
}

Nested Schema : workZones

Type: object

The work zones assigned to the capacity area. The work zones are not retrieved for a capacity area group.

Show Source

• href: string
  The link to the work zone collection.

{
    "description":"The work zones assigned to the capacity area. The work zones are not retrieved for a capacity area group.",
    "type":"object",
    "properties":{
        "href":{
            "description":"The link to the work zone collection.",
            "type":"string"
        }
    }
}

Nested Schema : definitionLevel

Type: array

The definition level set for the quota.

Show Source

• Array of: string

{
    "description":"The definition level set for the quota.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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 a 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
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 13:22:04 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.

{
    "label": "CapacityArea",
    "name": "Capacity Area",
    "type": "area",
    "status": "active",
    "workZones": {
        "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityAreas/CapacityArea/workZones"
    },
    "organizations": {
        "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityAreas/CapacityArea/organizations"
    },
    "capacityCategories": {
        "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityAreas/CapacityArea/capacityCategories"
    },
    "timeIntervals": {
        "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityAreas/CapacityArea/timeIntervals"
    },
    "timeSlots": {
        "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityAreas/CapacityArea/timeSlots"
    },
    "parentLabel": "66000",
    "configuration": {
        "definitionLevel": [
            "day"
        ],
        "isAllowCloseOnWorkzoneLevel": false,
        "byDay": "percentIncludeOtherActivities",
        "byCapacityCategory": "minutes",
        "byTimeSlot": "minutes",
        "isTimeSlotBase": false
    }
}

Back to Top