Update a work order area configuration
patch
/crmRestApi/resources/11.13.18.05/woAreaConfigurations/{ConfigNumber}
Request
Path Parameters
-
ConfigNumber(required): string
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
-
ConnectionCd: string
Title:
Connection Code
Maximum Length:30
Value that uniquely identifies the field service connection associated to this work order area configuration. -
EnabledFlag: boolean
Title:
Enable Work Order Area Retrieval
Maximum Length:1
Default Value:false
Indicates if the work order area configuration is enabled. -
FitnessFormulaSkill: integer
(int32)
Title:
Work Skill
Default Value:0
The work skill fitness filter used to retrieve the list of work order areas. -
FitnessFormulaWoZone: integer
(int32)
Title:
Work Zone
Default Value:0
The work zone fitness filter used to retrieve the list of work order areas. -
NumberRecordsToReturn: integer
(int32)
Title:
Number of Records to Return
Default Value:10
Indicates the number of records to return in the work order area list of values.
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 : woAreaConfigurations-item-response
Type:
Show Source
object
-
ConfigId: integer
(int64)
Read Only:
true
The unique identifier of the work order area configuration. -
ConfigNumber: string
Title:
Configuration Number
Maximum Length:30
Value that uniquely identifies the alternate unique identifier of the work order area configuration. This value can be system-generated, or can be configured. The default configuration is CDRM-0000000000. -
ConnectionCd: string
Title:
Connection Code
Maximum Length:30
Value that uniquely identifies the field service connection associated to this work order area configuration. -
ConnectionName: string
Title:
Connection Name
Read Only:true
Maximum Length:80
The user defined name for the field service connection associated to this work order area configuration. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the work order area configuration. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the work order area configuration was created. -
EnabledFlag: boolean
Title:
Enable Work Order Area Retrieval
Maximum Length:1
Default Value:false
Indicates if the work order area configuration is enabled. -
FitnessFormulaSkill: integer
(int32)
Title:
Work Skill
Default Value:0
The work skill fitness filter used to retrieve the list of work order areas. -
FitnessFormulaWoZone: integer
(int32)
Title:
Work Zone
Default Value:0
The work zone fitness filter used to retrieve the list of work order areas. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date and time of last update for the work order area configuration. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the work order area configuration. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberRecordsToReturn: integer
(int32)
Title:
Number of Records to Return
Default Value:10
Indicates the number of records to return in the work order area list of values.
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.