Get the work zone key

get

/rest/ofscMetadata/v1/workZoneKey

This operation retrieves the work zone key configuration. The work zone key information is represented by two objects: 'current' and 'pending'. This operation returns both objects when they are different but skips the 'pending' object if it is the same as the 'current' object. The order in which the fields are returned in the response is same as the order in which they are used in the key.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : workZoneKey
Type: object
The configuration of the work zone key.
Show Source
  • current
    The information related to the current work zone key. It is represented by an array of fields that is used to form the composite key. The order of the fields in the array is same as the order in which they appear in the key.
  • pending
    The information related to the work zone key that is yet to be applied. It is represented by an array of fields that is used to form the composite key. The order of the fields in the array is same as the order in which they appear in the key.
Nested Schema : current
Type: array
The information related to the current work zone key. It is represented by an array of fields that is used to form the composite key. The order of the fields in the array is same as the order in which they appear in the key.
Show Source
Nested Schema : pending
Type: array
The information related to the work zone key that is yet to be applied. It is represented by an array of fields that is used to form the composite key. The order of the fields in the array is same as the order in which they appear in the key.
Show Source
Nested Schema : workZoneKeyElement
Type: object
The element of the work zone key composite.
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 retrieve the information related to the configuration of the work zone key by submitting a GET request on the REST resource:

cURL Command Example

The following shows an example of the cURL command.

curl -X GET "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZoneKey" -H "Accept: application/json" -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...B2A_Zl7o6M7UpDmBK8EA" -H "Content-Type: application/json"

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Mon, 14 Oct 2019 09:38:21 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Response Body Example

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

{
    "current": [
        {
            "label": "ccity",
            "length": 4,
            "function": "caseInsensitive"
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workZones"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
        }
    ]
}
Back to Top