Update a work zone configuration key
patch
/crmRestApi/resources/11.13.18.05/workZoneConfigKeys/{WoKeyId}
Request
Path Parameters
-
WoKeyId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ConfigNumber: string
Title:
Configuration Number
Maximum Length:30
The value that uniquely identifies alternate unique identifier of the work order area configuration that's associated to this work zone configuration key. -
FsAPIParamName: string
Title:
Field Service API Parameter Name
Maximum Length:40
Identifies the API parameter name for the Oracle Field Service property used in the Oracle Field Service work zone key. -
FsPropertyLabel: string
Title:
Field Service Property Label
Maximum Length:30
Identifies the label for the Oracle Field Service property used in the Oracle Field Service work zone key. -
FsPropertyName: string
Title:
Field Service Property Name
Maximum Length:30
Default Value:NEW
Identifies the name for the Oracle Field Service property used in the Oracle Field Service work zone key. -
FsPropertyType: string
Title:
Property Type
Maximum Length:30
Identifies the type for the Oracle Field Service property used in the Oracle Field Service work zone key. -
FsWorkZoneKeyCase: string
Title:
Field Service Work Zone Key Case
Maximum Length:30
Identifies Oracle Field Service work zone key case sensitivity. -
FsWorkZoneKeyLength: integer
(int32)
Title:
Length
Identifies Oracle Field Service work zone key length. -
FsWorkZoneKeyOrder: integer
(int32)
Title:
Order
Identifies Oracle Field Service work zone key order. -
InitiateRetrievalFlag: boolean
Title:
Initiate Retrieval
Default Value:false
Indicates whether there is a request to initiate a retrieval for work zone key from Oracle Field Service. -
WoField: string
Title:
Work Order Field
Maximum Length:30
Identifies the work order field in Service that's associated to the Oracle Field Service work zone key.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : workZoneConfigKeys-item-response
Type:
Show Source
object
-
ConfigNumber: string
Title:
Configuration Number
Maximum Length:30
The value that uniquely identifies alternate unique identifier of the work order area configuration that's associated to this work zone configuration key. -
ConnectionCd: string
Title:
Connection Code
Maximum Length:30
Value that uniquely identifies the field service connection associated to this work zone configuration key. -
ConnectionName: string
Title:
Connection Name
Read Only:true
Maximum Length:80
The user defined name for the field service connection associated to this work zone configuration key. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the work zone configuration key. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the work zone configuration key was created. -
FsAPIParamName: string
Title:
Field Service API Parameter Name
Maximum Length:40
Identifies the API parameter name for the Oracle Field Service property used in the Oracle Field Service work zone key. -
FsPropertyLabel: string
Title:
Field Service Property Label
Maximum Length:30
Identifies the label for the Oracle Field Service property used in the Oracle Field Service work zone key. -
FsPropertyName: string
Title:
Field Service Property Name
Maximum Length:30
Default Value:NEW
Identifies the name for the Oracle Field Service property used in the Oracle Field Service work zone key. -
FsPropertyType: string
Title:
Property Type
Maximum Length:30
Identifies the type for the Oracle Field Service property used in the Oracle Field Service work zone key. -
FsWorkZoneKey: string
Title:
Field Service Work Zone Key
Read Only:true
Maximum Length:30
Identifies the work zone key name in Oracle Field Service. This is the same as property name. -
FsWorkZoneKeyCase: string
Title:
Field Service Work Zone Key Case
Maximum Length:30
Identifies Oracle Field Service work zone key case sensitivity. -
FsWorkZoneKeyLength: integer
(int32)
Title:
Length
Identifies Oracle Field Service work zone key length. -
FsWorkZoneKeyOrder: integer
(int32)
Title:
Order
Identifies Oracle Field Service work zone key order. -
InitiateRetrievalFlag: boolean
Title:
Initiate Retrieval
Default Value:false
Indicates whether there is a request to initiate a retrieval for work zone key from Oracle Field Service. -
KeyTypeCd: string
Title:
Configuration Key Type Code
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_WORK_ZONE
The code that identifies the type of configuration key. This is always set to ORA_SVC_WORK_ZONE. -
KeyTypeCdMeaning: string
Title:
Configuration Key Type
Read Only:true
Maximum Length:80
The name for the type of configuration key selected. This is the name given for the ORA_SVC_WORK_ZONE code. -
LastRetrievalDate: string
(date-time)
Title:
Last Retrieval Date.
Read Only:true
The date and time when the work zone configuration key was last retrieved. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date and time when the work zone configuration key was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the work zone configuration key. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WoField: string
Title:
Work Order Field
Maximum Length:30
Identifies the work order field in Service that's associated to the Oracle Field Service work zone key. -
WoKeyId: integer
(int64)
Read Only:
true
The unique identifier of the work zone configuration key.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.