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 TopResponse
Supported Media Types
- application/json
- application/schema+json
200 Response
This section describes the 200 status response for this operation.
Root Schema : workZoneKey
Type:
object
The configuration of the work zone key.
Show Source
-
current:
array 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:
array 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
-
Array of:
object workZoneKeyElement
The element of the work zone key composite.
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
-
Array of:
object workZoneKeyElement
The element of the work zone key composite.
Nested Schema : workZoneKeyElement
Type:
object
The element of the work zone key composite.
Show Source
-
apiParameterName:
string
The name of API parameter that represents the activity field or a property.
-
function:
string
The case sensitivity of the field value. The possible values are 'caseInsensitive' and 'firstWordCaseInsensitive'.
-
label:
string
Minimum Length:
1
Maximum Length:255
The label of the field or property. -
length:
integer
Minimum Length:
1
Maximum Length:9
The number of characters from the field value that is used in the key. -
order:
integer
The value that indicates the sorting order of the item in the list. The items are listed in ascending order.
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
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.
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>.fs.ocs.oraclecloud.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: Tue, 14 Jul 2020 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", "order": 0, "apiParameterName": "city" }, { "label": "czip", "length": 4, "function": "caseInsensitive", "order": 1, "apiParameterName": "postalCode" } ], "links": [ { "rel": "canonical", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones" }, { "rel": "describedby", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones" } ] }