Jump to

• Request
• Response

Update a single directly-assigned person for a specified responsibility template

patch

/hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/{TemplateId}/child/AssignedReps/{AssignedRepsUniqID}

Request

Path Parameters

• AssignedRepsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Responsibility Template Directly-Assigned Representatives resource and used to uniquely identify an instance of Responsibility Template Directly-Assigned Representatives. The client should not generate the hash key value. Instead, the client should query on the Responsibility Template Directly-Assigned Representatives collection resource in order to navigate to a specific instance of Responsibility Template Directly-Assigned Representatives to get the hash key.
• TemplateId(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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssignmentId: integer (int64)
  Title: Assignment ID

  Unique identifier of the directly-assigned person's assignment assigned to the area of responsibility.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier of the person who's assigned to the responsibility in the directly-assigned section.
• ResponsibilityName: string
  Title: Responsibility Name

  Maximum Length: 240

  Unique template responsibility name used to get the responsibility template's list of directly-assigned people.

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the directly-assigned person's assignment assigned to the area of responsibility.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResponsibilityName":{
            "title":"Responsibility Name",
            "maxLength":240,
            "type":"string",
            "description":"Unique template responsibility name used to get the responsibility template's list of directly-assigned people.",
            "nullable":false
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person who's assigned to the responsibility in the directly-assigned section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : areasOfResponsibilityTemplates-AssignedReps-item-response

Type: object

Show Source

• AsgResponsibilityId: integer (int64)
  Title: Area of Responsibility ID

  Surrogate identifier for the unique identifier for the area of responsibility. This is available only when updating an existing record.
• AssignmentId: integer (int64)
  Title: Assignment ID

  Unique identifier of the directly-assigned person's assignment assigned to the area of responsibility.
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Name of the directly-assigned person's assignment assigned to the area of responsibility.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the list of directly-assigned people in the responsibility template.
• CreationDate: string (date-time)
  Read Only: true

  Date when the list of directly-assigned people in the responsibility template was created.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonDisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the person listed in the directly-assigned section. Don't populate this attribute for POST (CREATE) action.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier of the person who's assigned to the responsibility in the directly-assigned section.
• ResponsibilityName: string
  Title: Responsibility Name

  Maximum Length: 240

  Unique template responsibility name used to get the responsibility template's list of directly-assigned people.
• TemplateId: integer (int64)
  Title: Template ID

  Unique identifier of the area of responsibility template.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the list of directly-assigned people in the responsibility template was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the list of directly-assigned people in the responsibility template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person who's assigned to the responsibility in the directly-assigned section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the directly-assigned person's assignment assigned to the area of responsibility.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AsgResponsibilityId":{
            "title":"Area of Responsibility ID",
            "type":"integer",
            "description":"Surrogate identifier for the unique identifier for the area of responsibility. This is available only when updating an existing record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the directly-assigned person's assignment assigned to the area of responsibility.",
            "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"
            }
        },
        "PersonDisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the person listed in the directly-assigned section. Don't populate this attribute for POST (CREATE) action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponsibilityName":{
            "title":"Responsibility Name",
            "maxLength":240,
            "type":"string",
            "description":"Unique template responsibility name used to get the responsibility template's list of directly-assigned people.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"Unique identifier of the area of responsibility template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

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