Jump to

• Request
• Response
• Examples

Update a technician preference

patch

/crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences/{TechnicianPreferenceId}

Request

Path Parameters

• TechnicianPreferenceId(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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• TechnicianPreferenceCd: string
  Title: Technician Preference Code

  Maximum Length: 30

  The code that identifies the preference type for this technician.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the technician preference is active.",
            "nullable":false,
            "default":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":250,
            "type":"string",
            "description":"Comments for the technician preference.",
            "nullable":true
        },
        "TechnicianPreferenceCd":{
            "title":"Technician Preference Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the preference type for this technician.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : serviceTechnicianPreferences-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AccountPartyId":{
            "title":"Account Party ID",
            "type":"integer",
            "description":"The unique identifier for the account the technician preference is for.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountPartyName":{
            "title":"Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account the technician preference is for.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier for the account the technician preference is for.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the technician preference is active.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":250,
            "type":"string",
            "description":"Comments for the technician preference.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the technician preference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the technician preference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the access schedule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the technician preference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProfileId":{
            "title":"Service Profile ID",
            "type":"integer",
            "description":"The unique identifier for the service profile the technician preference is for.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceProfileName":{
            "title":"Service Profile",
            "maxLength":400,
            "type":"string",
            "description":"The name of the service profile the technician preference is for.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProfileNumber":{
            "title":"Service Profile Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service profile the technician preference is for.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TechnicianName":{
            "title":"Field Service Resource",
            "maxLength":360,
            "type":"string",
            "description":"The name of the technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TechnicianNumber":{
            "title":"Field Service Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier for the technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TechnicianPartyId":{
            "title":"Field Service Resource Party ID",
            "type":"integer",
            "description":"The unique identifier for the technician.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TechnicianPreference":{
            "title":"Type",
            "maxLength":255,
            "type":"string",
            "description":"The preference type for the technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TechnicianPreferenceCd":{
            "title":"Technician Preference Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the preference type for this technician.",
            "nullable":false,
            "x-queryable":true
        },
        "TechnicianPreferenceId":{
            "title":"Technician Preference ID",
            "type":"integer",
            "description":"The unique identifier of the technician preference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

You can update a technician preference by submitting a PATCH request on the REST resource using the following cURL

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences/300100283990678

Example of Request Body

The following shows the contents of the Request Body in JSON format.

{
    "TechnicianPreferenceCd": "ORA_SVC_FS_TECH_PREF_CD_PREFRD",
    
    "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_PREFRD",
    "TechnicianPreference": "Preferred",
    "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-26T05:05:05+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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences/300100283990678",
            "name": "serviceTechnicianPreferences",
            "kind": "item"
        }
    ]
}

Back to Top