Jump to

• Request
• Response
• Examples

Update a technician's access hour

patch

/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessHours/{SchedHoursId}

Request

Path Parameters

• SchedHoursId(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's access hour is active.
• Comments: string
  Title: Comments

  Maximum Length: 250

  The comments for the access hour.
• EndHourFirstSlot: string
  Title: End Hour Slot 1

  Maximum Length: 10

  The end hour for the primary access hours.
• EndHourSecondSlot: string
  Title: End Hour Slot 2

  Maximum Length: 10

  The end hour for the additional access hours.
• StartHourFirstSlot: string
  Title: Start Hour Slot 1

  Maximum Length: 10

  The start hour of the primary access hours.
• StartHourSecondSlot: string
  Title: Start Hour Slot 2

  Maximum Length: 10

  The start hour of the additional access hours.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the technician's access hour is active.",
            "nullable":false,
            "default":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":250,
            "type":"string",
            "description":"The comments for the access hour.",
            "nullable":true
        },
        "EndHourFirstSlot":{
            "title":"End Hour Slot 1",
            "maxLength":10,
            "type":"string",
            "description":"The end hour for the primary access hours.",
            "nullable":false
        },
        "EndHourSecondSlot":{
            "title":"End Hour Slot 2",
            "maxLength":10,
            "type":"string",
            "description":"The end hour for the additional access hours.",
            "nullable":true
        },
        "StartHourFirstSlot":{
            "title":"Start Hour Slot 1",
            "maxLength":10,
            "type":"string",
            "description":"The start hour of the primary access hours.",
            "nullable":false
        },
        "StartHourSecondSlot":{
            "title":"Start Hour Slot 2",
            "maxLength":10,
            "type":"string",
            "description":"The start hour of the additional access hours.",
            "nullable":true
        }
    }
}

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 : serviceTechnicianAccessHours-item-response

Type: object

Show Source

• AccScheduleId: integer (int64)
  Title: Access Schedule ID

  The unique identifier of the access schedule.
• AccScheduleName: string
  Title: Schedule Name

  Read Only: true

  Maximum Length: 50

  The name of the access schedule.
• AccScheduleNumber: string
  Title: Schedule Number

  Read Only: true

  Maximum Length: 30

  The alternate unique identifier of the access schedule.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the technician's access hour is active.
• Comments: string
  Title: Comments

  Maximum Length: 250

  The comments for the access hour.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the access hour.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the access hour was created.
• DayOfWeekCd: string
  Title: Day or Week Code

  Maximum Length: 30

  The code that identifies the day of the week for the access hours.
• DayOfWeekCdMeaning: string
  Title: Day of Week

  Read Only: true

  Maximum Length: 255

  The day of the week for the access hours.
• DisplaySequence: string
  Title: Display Sequence

  Read Only: true

  Maximum Length: 80

  The display sequence for sorting by day.
• EndHourFirstSlot: string
  Title: End Hour Slot 1

  Maximum Length: 10

  The end hour for the primary access hours.
• EndHourSecondSlot: string
  Title: End Hour Slot 2

  Maximum Length: 10

  The end hour for the additional access hours.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the access hours were last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the access hours.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverrideCd: string
  Title: Override Code

  Maximum Length: 30

  The code that identifies the type of override applied to the access hours.
• OverrideCdMeaning: string
  Title: Override

  Read Only: true

  Maximum Length: 255

  The type of override applied to the access hours.
• OverrideServiceProfileId: integer (int64)
  Title: Override Service Profile ID

  The unique identifier for the service profile that overrides the access hours.
• OverrideServiceProfileName: string
  Title: Service Profile

  Read Only: true

  Maximum Length: 400

  The name of the service profile that overrides the access hours.
• OverrideServiceProfileNumber: string
  Title: Service Profile Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the service profile that overrides the access hours.
• OverrideWoId: integer (int64)
  Title: Override Work Order ID

  The unique identifier for the work order that overrides the access hours.
• OverrideWoNumber: string
  Title: Work Order Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the work order that overrides the access hours.
• SchedHoursId: integer (int64)
  Title: Schedule Hours ID

  The unique identifier of the access hours.
• StartHourFirstSlot: string
  Title: Start Hour Slot 1

  Maximum Length: 10

  The start hour of the primary access hours.
• StartHourSecondSlot: string
  Title: Start Hour Slot 2

  Maximum Length: 10

  The start hour of the additional access hours.

{
    "type":"object",
    "properties":{
        "AccScheduleId":{
            "title":"Access Schedule ID",
            "type":"integer",
            "description":"The unique identifier of the access schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccScheduleName":{
            "title":"Schedule Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the access schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccScheduleNumber":{
            "title":"Schedule Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the access schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the technician's access hour is active.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":250,
            "type":"string",
            "description":"The comments for the access hour.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the access hour.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the access hour was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DayOfWeekCd":{
            "title":"Day or Week Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the day of the week for the access hours.",
            "nullable":false,
            "x-queryable":true
        },
        "DayOfWeekCdMeaning":{
            "title":"Day of Week",
            "maxLength":255,
            "type":"string",
            "description":"The day of the week for the access hours.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "maxLength":80,
            "type":"string",
            "description":"The display sequence for sorting by day.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndHourFirstSlot":{
            "title":"End Hour Slot 1",
            "maxLength":10,
            "type":"string",
            "description":"The end hour for the primary access hours.",
            "nullable":false,
            "x-queryable":true
        },
        "EndHourSecondSlot":{
            "title":"End Hour Slot 2",
            "maxLength":10,
            "type":"string",
            "description":"The end hour for the additional access hours.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the access hours were 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 access hours.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideCd":{
            "title":"Override Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the type of override applied to the access hours.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideCdMeaning":{
            "title":"Override",
            "maxLength":255,
            "type":"string",
            "description":"The type of override applied to the access hours.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideServiceProfileId":{
            "title":"Override Service Profile ID",
            "type":"integer",
            "description":"The unique identifier for the service profile that overrides the access hours.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OverrideServiceProfileName":{
            "title":"Service Profile",
            "maxLength":400,
            "type":"string",
            "description":"The name of the service profile that overrides the access hours.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideServiceProfileNumber":{
            "title":"Service Profile Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service profile that overrides the access hours.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideWoId":{
            "title":"Override Work Order ID",
            "type":"integer",
            "description":"The unique identifier for the work order that overrides the access hours.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OverrideWoNumber":{
            "title":"Work Order Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the work order that overrides the access hours.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedHoursId":{
            "title":"Schedule Hours ID",
            "type":"integer",
            "description":"The unique identifier of the access hours.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartHourFirstSlot":{
            "title":"Start Hour Slot 1",
            "maxLength":10,
            "type":"string",
            "description":"The start hour of the primary access hours.",
            "nullable":false,
            "x-queryable":true
        },
        "StartHourSecondSlot":{
            "title":"Start Hour Slot 2",
            "maxLength":10,
            "type":"string",
            "description":"The start hour of the additional access hours.",
            "nullable":true,
            "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's access hour 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/serviceTechnicianAccessHours/300100284045602

Example of Request Body

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

{"Comments": "Updated new hour"}

Example of Response Body

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

{
    "SchedHoursId": 300100284045602,
    "AccScheduleId": 300100283975427,
    "AccScheduleName": "FSACCOUNT Schedule",
    "AccScheduleNumber": "CDRM_1",
    "DayOfWeekCd": "MONDAY",
    "DayOfWeekCdMeaning": "Monday",
    "StartHourFirstSlot": "T08:00",
    "EndHourFirstSlot": "T11:00",
    "StartHourSecondSlot": "T12:00",
    "EndHourSecondSlot": "T17:00",
    "OverrideCd": null,
    "OverrideCdMeaning": null,
    "OverrideServiceProfileId": null,
    "OverrideServiceProfileName": null,
    "OverrideServiceProfileNumber": null,
    "OverrideWoId": null,
    "OverrideWoNumber": null,
    "ActiveFlag": true,
    "Comments": "Updated new hour",
    "CreatedBy": "MHoope",
    "CreationDate": "2024-03-26T05:39:10+00:00",
    "LastUpdateDate": "2024-03-26T06:04:28+00:00",
    "LastUpdatedBy": "MHoope",
    "DisplaySequence": "2",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessHours/300100284045602",
            "name": "serviceTechnicianAccessHours",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessHours/300100284045602",
            "name": "serviceTechnicianAccessHours",
            "kind": "item"
        }
    ]
}

Back to Top