Get a capacity area

get

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

This operation retrieves details about 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 : CapacityAreaConfiguration
Type: object
The schema of the capacity area object.
Show Source
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
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
Nested Schema : configuration
Type: object
The configuration of the capacity area.
Show Source
  • 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.
  • 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.
  • 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
    The definition level set for the quota.
  • 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.
  • 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.
Nested Schema : organizations
Type: object
The organizations assigned to the capacity area. The organizations are not retrieved for a capacity area group.
Show Source
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
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
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
Nested Schema : definitionLevel
Type: array
The definition level set for the quota.
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 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>.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 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>.etadirect.com/rest/ofscMetadata/v1/capacityAreas/CapacityArea/workZones"
    },
    "organizations": {
        "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/capacityAreas/CapacityArea/organizations"
    },
    "capacityCategories": {
        "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/capacityAreas/CapacityArea/capacityCategories"
    },
    "timeIntervals": {
        "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/capacityAreas/CapacityArea/timeIntervals"
    },
    "timeSlots": {
        "href": "https://<instance_name>.etadirect.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