Create a technician preference
post
/crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account Party ID
The unique identifier for the account the technician preference is for. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the technician preference is active. -
Comments: string
Title:
Comments
Maximum Length:250
Comments for the technician preference. -
ServiceProfileId: integer
(int64)
Title:
Service Profile ID
The unique identifier for the service profile the technician preference is for. -
TechnicianPartyId: integer
(int64)
Title:
Field Service Resource Party ID
The unique identifier for the technician. -
TechnicianPreferenceCd: string
Title:
Technician Preference Code
Maximum Length:30
The code that identifies the preference type for this technician. -
TechnicianPreferenceId: integer
(int64)
Title:
Technician Preference ID
The unique identifier of the technician preference.
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 : serviceTechnicianPreferences-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account Party ID
The unique identifier for the account the technician preference is for. -
AccountPartyName: string
Title:
Account
Read Only:true
Maximum Length:360
The name of the account the technician preference is for. -
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The public unique identifier for the account the technician preference is for. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the technician preference is active. -
Comments: string
Title:
Comments
Maximum Length:250
Comments for the technician preference. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the technician preference. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the technician preference was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the access schedule was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the technician preference. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ServiceProfileId: integer
(int64)
Title:
Service Profile ID
The unique identifier for the service profile the technician preference is for. -
ServiceProfileName: string
Title:
Service Profile
Read Only:true
Maximum Length:400
The name of the service profile the technician preference is for. -
ServiceProfileNumber: string
Title:
Service Profile Number
Read Only:true
Maximum Length:30
The public unique identifier of the service profile the technician preference is for. -
TechnicianName: string
Title:
Field Service Resource
Read Only:true
Maximum Length:360
The name of the technician. -
TechnicianNumber: string
Title:
Field Service Resource Number
Read Only:true
Maximum Length:30
The public unique identifier for the technician. -
TechnicianPartyId: integer
(int64)
Title:
Field Service Resource Party ID
The unique identifier for the technician. -
TechnicianPreference: string
Title:
Type
Read Only:true
Maximum Length:255
The preference type for the technician. -
TechnicianPreferenceCd: string
Title:
Technician Preference Code
Maximum Length:30
The code that identifies the preference type for this technician. -
TechnicianPreferenceId: integer
(int64)
Title:
Technician Preference ID
The unique identifier of the technician preference.
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.
Examples
You can create a technician preference by submitting a POST request on the REST resource using the following cURL
cURL Command
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences/
Example of Request Body
The following shows the contents of the Request Body in JSON format.
{ "TechnicianPartyId": 300100172781411, "TechnicianPreferenceCd": "ORA_SVC_FS_TECH_PREF_CD_REQIRD", "AccountPartyId": 300100126721679, "ActiveFlag":"Y" }
Example of Response Body
The following shows the contents of the Response Body in JSON format.
{ "TechnicianPreferenceId": 300100283990678, "TechnicianPartyId": 300100172781411, "TechnicianName": "John Technician", "TechnicianNumber": "CDRM_828565", "TechnicianPreferenceCd": "ORA_SVC_FS_TECH_PREF_CD_REQIRD", "TechnicianPreference": "Required", "ServiceProfileId": null, "ServiceProfileName": null, "ServiceProfileNumber": null, "AccountPartyId": 300100126721679, "AccountPartyName": "FSACCOUNT", "AccountPartyNumber": "CDRM_721531", "Comments": null, "ActiveFlag": true, "CreatedBy": "MHoope", "CreationDate": "2024-03-26T04:47:40+00:00", "LastUpdateDate": "2024-03-26T04:47:40.032+00:00", "LastUpdatedBy": "MHoope", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences/300100283990678", "name": "serviceTechnicianPreferences", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences/300100283990678", "name": "serviceTechnicianPreferences", "kind": "item" } ] }