Jump to

• Request
• Response

Get basic details for all responsibility templates

get

/hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a single responsibility template that match the primary key criteria specified.
    Finder Variables
    • TemplateId; integer; Surrogate identifier for the responsibility template.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BypassPreview; string; Indicates whether the responsibility template should bypass the preview step during autoprovisioning. Valid values are Y and N. The default value is N.
  • CreatedBy; string; User who created the responsibility template.
  • CreationDate; string; Date and time when the responsibility template was created.
  • EndDate; string; The end date of the responsibility template.
  • LastUpdateDate; string; Date and time when the responsibility template was last updated.
  • LastUpdatedBy; string; Surrogate identifier for the person who last updated the responsibility template.
  • RepsonsibilityType; string; The responsibility type code of the responsibility template.
  • ResponsibilityTypeMeaning; string; The responsibility type of the responsibility template.
  • StartDate; string; Start date of the responsibility template.
  • Status; string; Status of the responsibility template. Valid values are A and I. The default value is A.
  • StatusIndicator; string; Autoprovisioning progress status of the responsibility template. This is for internal use only and can only be viewed, not updated. Valid values are UPDATABLE_NO_PREVIEW, READONLY, UPDATABLE_PREVIEW, REVIEW_COMPLETED, COMMIT_COMPLETED.
  • SyncEnabled; string; Synchronization indicator for the responsibility template and associated child area of responsibility. Valid values are Y and N. The default value is N.
  • TemplateCode; string; Unique code for the responsibility template.
  • TemplateDescription; string; Detailed description for the responsibility template.
  • TemplateId; integer; Unique identifier for the responsibility template.
  • TemplateName; string; Name of the responsibility template.
  • Usage; string; Description of the purpose for the responsibility.
  • WorkContactsFlag; boolean; Indicator to display the representative as a contact. Valid values are Y and N. The default value is Y.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/areasOfResponsibilityTemplates-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object areasOfResponsibilityTemplates-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/areasOfResponsibilityTemplates-item-response"
    }
}

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

Type: object

Show Source

• AoRTemplateCriteria: array Responsibility Template Criteria
  Title: Responsibility Template Criteria

  The AoRTemplateCriteria resource is the child of the areasOfResponsibilityTemplates resource and provides the details of the autoprovisioning criteria attributes.
• AoRTemplateScope: array Responsibility Template Scope
  Title: Responsibility Template Scope

  The AoRTemplateScope resource is the child of the areasOfResponsibilityTemplates resource and provides the details of the scope attributes.
• AssignedReps: array Responsibility Template Directly-Assigned Representatives
  Title: Responsibility Template Directly-Assigned Representatives

  The AssignedReps resource is the child of the areasOfResponsibilityTemplates resource and provides the list of people who are directly-assigned to this template.
• BypassPreview: string
  Title: Bypass preview

  Maximum Length: 30

  Indicates whether the responsibility template should bypass the preview step during autoprovisioning. Valid values are Y and N. The default value is N.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the responsibility template.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the responsibility template was created.
• EndDate: string (date)
  Title: To Date

  The end date of the responsibility template.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the responsibility template was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Surrogate identifier for the person who last updated the responsibility template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RepsonsibilityType: string
  Title: Responsibility Type

  Maximum Length: 30

  The responsibility type code of the responsibility template.
• ResponsibilityTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The responsibility type of the responsibility template.
• StartDate: string (date)
  Title: From Date

  Start date of the responsibility template.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: A

  Status of the responsibility template. Valid values are A and I. The default value is A.
• StatusIndicator: string
  Maximum Length: 30

  Autoprovisioning progress status of the responsibility template. This is for internal use only and can only be viewed, not updated. Valid values are UPDATABLE_NO_PREVIEW, READONLY, UPDATABLE_PREVIEW, REVIEW_COMPLETED, COMMIT_COMPLETED.
• SyncEnabled: string
  Title: Enable Synchronization

  Maximum Length: 30

  Default Value: N

  Synchronization indicator for the responsibility template and associated child area of responsibility. Valid values are Y and N. The default value is N.
• TemplateCode: string
  Title: Code

  Maximum Length: 30

  Unique code for the responsibility template.
• TemplateDescription: string
  Title: Description

  Maximum Length: 1000

  Detailed description for the responsibility template.
• TemplateId: integer (int64)
  Unique identifier for the responsibility template.
• TemplateName: string
  Title: Name

  Maximum Length: 240

  Name of the responsibility template.
• Usage: string
  Title: Usage

  Maximum Length: 4000

  Description of the purpose for the responsibility.
• WorkContactsFlag: boolean
  Title: Work Contacts

  Maximum Length: 30

  Default Value: true

  Indicator to display the representative as a contact. Valid values are Y and N. The default value is Y.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Surrogate identifier for the person who last updated the responsibility template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the responsibility template. Valid values are A and I. The default value is A.",
            "nullable":true,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the responsibility template was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Usage":{
            "title":"Usage",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the purpose for the responsibility.",
            "nullable":true,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the responsibility template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SyncEnabled":{
            "title":"Enable Synchronization",
            "maxLength":30,
            "type":"string",
            "description":"Synchronization indicator for the responsibility template and associated child area of responsibility. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "BypassPreview":{
            "title":"Bypass preview",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the responsibility template should bypass the preview step during autoprovisioning. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkContactsFlag":{
            "title":"Work Contacts",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to display the representative as a contact. Valid values are Y and N. The default value is Y.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "AssignedReps":{
            "title":"Responsibility Template Directly-Assigned Representatives",
            "type":"array",
            "description":"The AssignedReps resource is the child of the areasOfResponsibilityTemplates resource and provides the list of people who are directly-assigned to this template.",
            "items":{
                "$ref":"#/components/schemas/areasOfResponsibilityTemplates-AssignedReps-item-response"
            }
        },
        "TemplateDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Detailed description for the responsibility template.",
            "nullable":true,
            "x-queryable":true
        },
        "AoRTemplateCriteria":{
            "title":"Responsibility Template Criteria",
            "type":"array",
            "description":"The AoRTemplateCriteria resource is the child of the areasOfResponsibilityTemplates resource and provides the details of the autoprovisioning criteria attributes.",
            "items":{
                "$ref":"#/components/schemas/areasOfResponsibilityTemplates-AoRTemplateCriteria-item-response"
            },
            "x-cardinality":"1"
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The end date of the responsibility template.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"Start date of the responsibility template.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique code for the responsibility template.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusIndicator":{
            "maxLength":30,
            "type":"string",
            "description":"Autoprovisioning progress status of the responsibility template. This is for internal use only and can only be viewed, not updated. Valid values are UPDATABLE_NO_PREVIEW, READONLY, UPDATABLE_PREVIEW, REVIEW_COMPLETED, COMMIT_COMPLETED.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponsibilityTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The responsibility type of the responsibility template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the responsibility template.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AoRTemplateScope":{
            "title":"Responsibility Template Scope",
            "type":"array",
            "description":"The AoRTemplateScope resource is the child of the areasOfResponsibilityTemplates resource and provides the details of the scope attributes.",
            "items":{
                "$ref":"#/components/schemas/areasOfResponsibilityTemplates-AoRTemplateScope-item-response"
            }
        },
        "TemplateId":{
            "type":"integer",
            "description":"Unique identifier for the responsibility template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the responsibility template was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RepsonsibilityType":{
            "title":"Responsibility Type",
            "maxLength":30,
            "type":"string",
            "description":"The responsibility type code of the responsibility template.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Responsibility Template Criteria

Type: array

Title: Responsibility Template Criteria

The AoRTemplateCriteria resource is the child of the areasOfResponsibilityTemplates resource and provides the details of the autoprovisioning criteria attributes.

Show Source

• Array of: object areasOfResponsibilityTemplates-AoRTemplateCriteria-item-response

{
    "title":"Responsibility Template Criteria",
    "type":"array",
    "description":"The AoRTemplateCriteria resource is the child of the areasOfResponsibilityTemplates resource and provides the details of the autoprovisioning criteria attributes.",
    "items":{
        "$ref":"#/components/schemas/areasOfResponsibilityTemplates-AoRTemplateCriteria-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Responsibility Template Scope

Type: array

Title: Responsibility Template Scope

The AoRTemplateScope resource is the child of the areasOfResponsibilityTemplates resource and provides the details of the scope attributes.

Show Source

• Array of: object areasOfResponsibilityTemplates-AoRTemplateScope-item-response

{
    "title":"Responsibility Template Scope",
    "type":"array",
    "description":"The AoRTemplateScope resource is the child of the areasOfResponsibilityTemplates resource and provides the details of the scope attributes.",
    "items":{
        "$ref":"#/components/schemas/areasOfResponsibilityTemplates-AoRTemplateScope-item-response"
    }
}

Nested Schema : Responsibility Template Directly-Assigned Representatives

Type: array

Title: Responsibility Template Directly-Assigned Representatives

The AssignedReps resource is the child of the areasOfResponsibilityTemplates resource and provides the list of people who are directly-assigned to this template.

Show Source

• Array of: object areasOfResponsibilityTemplates-AssignedReps-item-response

{
    "title":"Responsibility Template Directly-Assigned Representatives",
    "type":"array",
    "description":"The AssignedReps resource is the child of the areasOfResponsibilityTemplates resource and provides the list of people who are directly-assigned to this template.",
    "items":{
        "$ref":"#/components/schemas/areasOfResponsibilityTemplates-AssignedReps-item-response"
    }
}

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

Type: object

Show Source

• BusinessUnitIds: string
  Maximum Length: 4000

  Unique identifier of the business unit in the responsibility template scope section.Multiple value accepted.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the responsibility template criteria.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the responsibility template criteria was created.
• DepartmentIds: string
  Maximum Length: 4000

  Unique identifier of the department in the responsibility template criteria section. Multiple values accepted.
• JobFamilyIds: string
  Maximum Length: 4000

  Unique identifier of the job family in the responsibility template criteria section..Multiple value accepted.
• JobFunctionCode: string
  Maximum Length: 30

  Code of the job function in the responsibility template criteria section.
• JobIds: string
  Maximum Length: 4000

  Name of the job in the responsibility template criteria section. Multiple values accepted.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the responsibility template criteria was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the responsibility template criteria.
• LegalEntityId: integer (int64)
  Unique identifier of the legal employer in the responsibility template criteria section.
• LegislationCode: string
  Maximum Length: 30

  Legislation code of the country in the responsibility template criteria section.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationIds: string
  Maximum Length: 4000

  Unique identifier of the location in the responsibility template criteria section. Multiple values accepted.
• PositionIds: string
  Maximum Length: 4000

  Unique identifier of the position in the responsibility template criteria section. Multiple values accepted.
• RoleIds: string
  Maximum Length: 4000

  Unique identifier of the user role in the responsibility template criteria section. Multiple values accepted.
• SystemPersonType: string
  Maximum Length: 30

  Name of the system person type in the responsibility template criteria section.
• TemplateCriteriaId: integer (int64)
  Unique template criteria identifier used to get the responsibility template criteria section.
• TemplateId: integer (int64)
  Unique template identifier used to get the responsibility template criteria section.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the responsibility template criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the responsibility template criteria was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemPersonType":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the system person type in the responsibility template criteria section.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the responsibility template criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code of the country in the responsibility template criteria section.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentIds":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the department in the responsibility template criteria section. Multiple values accepted.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateCriteriaId":{
            "type":"integer",
            "description":"Unique template criteria identifier used to get the responsibility template criteria section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobIds":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the job in the responsibility template criteria section. Multiple values accepted.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleIds":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the user role in the responsibility template criteria section. Multiple values accepted.",
            "nullable":true,
            "x-queryable":true
        },
        "JobFunctionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the job function in the responsibility template criteria section.",
            "nullable":true,
            "x-queryable":true
        },
        "JobFamilyIds":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the job family in the responsibility template criteria section..Multiple value accepted.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Unique identifier of the legal employer in the responsibility template criteria section.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationIds":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the location in the responsibility template criteria section. Multiple values accepted.",
            "nullable":true,
            "x-queryable":true
        },
        "PositionIds":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the position in the responsibility template criteria section. Multiple values accepted.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitIds":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the business unit in the responsibility template scope section.Multiple value accepted.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateId":{
            "type":"integer",
            "description":"Unique template identifier used to get the responsibility template criteria section.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the responsibility template criteria was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Nested Schema : areasOfResponsibilityTemplates-AoRTemplateScope-item-response

Type: object

Show Source

• AttributeName: string
  Title: Attribute Name

  Maximum Length: 30

  Name of the scope attribute. Attribute names must be unique and can't be duplicated. Valid values are: AOR_LEGAL_EMPLOYER, AOR_BUSINESS_UNIT, AOR_DEPARTMENT, AOR_LOCATION, AOR_JOB, AOR_POSITION, AOR_ASSIGNMENT_CATEGORY, AOR_BENEIFIT_GROUP, AOR_BARG_UNIT, AOR_COUNTRY, AOR_GRADE, AOR_JOB_FAMILY, AOR_JOB_FUNCTION, AOR_PAYROLL, AOR_PAYROLL_STATUTORY_UNIT, AOR_TAX_RPTG_UNIT, AOR_LEGISLATIVE_DATA_GRP, AOR_RECRUIT_TYPE, AOR_RECRUIT_LOC_HIER, AOR_RECRUIT_ORG_HIER, AOR_HIERARCHY_TYPE, or AOR_LAST_NAME_FROM.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the responsibility template scope.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the responsibility template scope was created.
• DefaultValue: string
  Title: Value

  Maximum Length: 1000

  Related attribute codes when AttributeName relates to: AOR_ASSIGNMENT_CATEGORY, AOR_JOB_FUNCTION, AOR_RECRUIT_TYPE, AOR_HIERARCHY_TYPE, or AOR_LAST_NAME_FROM. For AOR_HIERARCHY_TYPE, specify one of: AOR_ORG, AOR_POS, AOR_DEPT, or AOR_SUPV. For AOR_LAST_NAME_FROM, provide the specific text for the starting range text of the last name.
• DefaultValue2: string
  Maximum Length: 1000

  Related attribute codes when AttributeName relates to either AOR_BARG_UNIT or AOR_COUNTRY. If you provided DefaultValue of AOR_ORG, AOR_POS, or AOR_DEPT, provide the associated hierarchy tree ID.
• DefaultValue3: string
  Maximum Length: 1000

  Related attribute codes when AttributeName relates to any of these: Last Name End, Recruiting Org Tree. If you provided DefaultValue of AOR_LAST_NAME_FROM, provide the specific text for the ending range text of the last name. If you provided DefaultValue of AOR_ORG, AOR_POS, or AOR_DEPT, provide the associated hierarchy tree code.
• DefaultValue4: string
  Maximum Length: 1000

  Recruiting Org Tree Version attribute code when AttributeName is AOR_RECRUIT_ORG_HIER.
• DefaultValue5: string
  Maximum Length: 1000

  Number of hierarchy levels if you provided AttributeName of AOR_HIERARCHY_TYPE.
• DefaultValue6: string
  Maximum Length: 1000

  Value for Include Top Hierarchy Node if you provided AttributeName of AOR_HIERARCHY_TYPE. Valid values are Y or N. The default value is N.
• DefaultValueNameChoice: string
  Maximum Length: 255

  List of value switcher for values to be stored in DefaultValue2, DefaultValue3, DefaultValue5 and DefaultValue6 attributes.
• DefaultValueNumber: integer (int64)
  Related attribute ID when AttributeName is any of these: AOR_LEGAL_EMPLOYER, AOR_BUSINESS_UNIT, AOR_DEPARTMENT, AOR_LOCATION, AOR_JOB, AOR_POSITION, AOR_GRADE, AOR_JOB_FAMILY, AOR_PAYROLL_STATUTORY_UNIT, AOR_TAX_RPTG_UNIT, AOR_LEGISLATIVE_DATA_GRP, AOR_RECRUIT_LOC_HIER or AOR_RECRUIT_ORG_HIER. If you provided DefaultValue of AOR_ORG, AOR_POS, or AOR_DEPT, provide the top node code of the associated hierarchy tree. If you provided DefaultValue of AOR_SUPV, provide the top supervisor's person ID.
• DisplaySequence: integer (int32)
  Title: Display Order

  Unique sequence number representing the display order of the scope attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the responsibility template scope was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the responsibility template scope.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 30

  Default Value: false

  Indicator of whether the AttributeName is required. Populate this field only if DefaultValue is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.
• RequiredFlag2: string
  Maximum Length: 30

  Default Value: N

  Indicator of whether the AttributeName is required. Populate this field only if DefaultValue2 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.
• RequiredFlag3: string
  Maximum Length: 30

  Default Value: N

  Indicator of whether the AttributeName is required. Populate this field only if DefaultValue3 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.
• RequiredFlag4: string
  Maximum Length: 30

  Default Value: N

  Indicator of whether the AttributeName is required. Populate this field only if DefaultValue4 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.
• RequiredFlag5: string
  Maximum Length: 30

  Default Value: N

  Indicator of whether the AttributeName is required. Populate this field only if DefaultValue5 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.
• RequiredFlag6: string
  Maximum Length: 30

  Default Value: N

  Indicator of whether the AttributeName is required. Populate this field only if DefaultValue6 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.
• RequiredFlagNumber: string
  Maximum Length: 30

  Default Value: N

  Indicator of whether the AttributeName is required. Populate this field only if DefaultValueNumber is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.
• TemplateDetailsId: integer (int64)
  Surrogate identifier for a scope attribute of a template.
• TemplateId: integer (int64)
  Template identifier for the responsibility template scope.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the responsibility template scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the responsibility template scope was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the responsibility template scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Order",
            "type":"integer",
            "description":"Unique sequence number representing the display order of the scope attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "TemplateDetailsId":{
            "type":"integer",
            "description":"Surrogate identifier for a scope attribute of a template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Value",
            "maxLength":1000,
            "type":"string",
            "description":"Related attribute codes when AttributeName relates to: AOR_ASSIGNMENT_CATEGORY, AOR_JOB_FUNCTION, AOR_RECRUIT_TYPE, AOR_HIERARCHY_TYPE, or AOR_LAST_NAME_FROM. For AOR_HIERARCHY_TYPE, specify one of: AOR_ORG, AOR_POS, AOR_DEPT, or AOR_SUPV. For AOR_LAST_NAME_FROM, provide the specific text for the starting range text of the last name.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValueNameChoice":{
            "maxLength":255,
            "type":"string",
            "description":"List of value switcher for values to be stored in DefaultValue2, DefaultValue3, DefaultValue5 and DefaultValue6 attributes.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DefaultValueLovSwitcher"
                ]
            },
            "x-queryable":true
        },
        "DefaultValueNumber":{
            "type":"integer",
            "description":"Related attribute ID when AttributeName is any of these: AOR_LEGAL_EMPLOYER, AOR_BUSINESS_UNIT, AOR_DEPARTMENT, AOR_LOCATION, AOR_JOB, AOR_POSITION, AOR_GRADE, AOR_JOB_FAMILY, AOR_PAYROLL_STATUTORY_UNIT, AOR_TAX_RPTG_UNIT, AOR_LEGISLATIVE_DATA_GRP, AOR_RECRUIT_LOC_HIER or AOR_RECRUIT_ORG_HIER. If you provided DefaultValue of AOR_ORG, AOR_POS, or AOR_DEPT, provide the top node code of the associated hierarchy tree. If you provided DefaultValue of AOR_SUPV, provide the top supervisor's person ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18,
                "dependencies":[
                    "DefaultValueNumberLovSwitcher"
                ]
            },
            "x-queryable":true
        },
        "RequiredFlag2":{
            "maxLength":30,
            "type":"string",
            "description":"Indicator of whether the AttributeName is required. Populate this field only if DefaultValue2 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "DefaultValue2":{
            "maxLength":1000,
            "type":"string",
            "description":"Related attribute codes when AttributeName relates to either AOR_BARG_UNIT or AOR_COUNTRY. If you provided DefaultValue of AOR_ORG, AOR_POS, or AOR_DEPT, provide the associated hierarchy tree ID.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "DefaultValueLovSwitcher2"
                ]
            },
            "x-queryable":true
        },
        "RequiredFlag3":{
            "maxLength":30,
            "type":"string",
            "description":"Indicator of whether the AttributeName is required. Populate this field only if DefaultValue3 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "DefaultValue3":{
            "maxLength":1000,
            "type":"string",
            "description":"Related attribute codes when AttributeName relates to any of these: Last Name End, Recruiting Org Tree. If you provided DefaultValue of AOR_LAST_NAME_FROM, provide the specific text for the ending range text of the last name. If you provided DefaultValue of AOR_ORG, AOR_POS, or AOR_DEPT, provide the associated hierarchy tree code.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredFlag4":{
            "maxLength":30,
            "type":"string",
            "description":"Indicator of whether the AttributeName is required. Populate this field only if DefaultValue4 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the scope attribute. Attribute names must be unique and can't be duplicated. Valid values are: AOR_LEGAL_EMPLOYER, AOR_BUSINESS_UNIT, AOR_DEPARTMENT, AOR_LOCATION, AOR_JOB, AOR_POSITION, AOR_ASSIGNMENT_CATEGORY, AOR_BENEIFIT_GROUP, AOR_BARG_UNIT, AOR_COUNTRY, AOR_GRADE, AOR_JOB_FAMILY, AOR_JOB_FUNCTION, AOR_PAYROLL, AOR_PAYROLL_STATUTORY_UNIT, AOR_TAX_RPTG_UNIT, AOR_LEGISLATIVE_DATA_GRP, AOR_RECRUIT_TYPE, AOR_RECRUIT_LOC_HIER, AOR_RECRUIT_ORG_HIER, AOR_HIERARCHY_TYPE, or AOR_LAST_NAME_FROM.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator of whether the AttributeName is required. Populate this field only if DefaultValue is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RequiredFlag5":{
            "maxLength":30,
            "type":"string",
            "description":"Indicator of whether the AttributeName is required. Populate this field only if DefaultValue5 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "RequiredFlag6":{
            "maxLength":30,
            "type":"string",
            "description":"Indicator of whether the AttributeName is required. Populate this field only if DefaultValue6 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "DefaultValue6":{
            "maxLength":1000,
            "type":"string",
            "description":"Value for Include Top Hierarchy Node if you provided AttributeName of AOR_HIERARCHY_TYPE. Valid values are Y or N. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateId":{
            "type":"integer",
            "description":"Template identifier for the responsibility template scope.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultValue4":{
            "maxLength":1000,
            "type":"string",
            "description":"Recruiting Org Tree Version attribute code when AttributeName is AOR_RECRUIT_ORG_HIER.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the responsibility template scope was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue5":{
            "maxLength":1000,
            "type":"string",
            "description":"Number of hierarchy levels if you provided AttributeName of AOR_HIERARCHY_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredFlagNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Indicator of whether the AttributeName is required. Populate this field only if DefaultValueNumber is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"N",
            "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 : 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"
    }
}

Links

commitAutoProvisionJobOutput

Operation: /hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/action/commitAutoProvisionJobOutput

Applies autoprovisioned responsibilities for all representatives.

findByAdvancedSearch

Operation: /hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/action/findByAdvancedSearch

Finds areas of responsibility template records that match the specified advanced search criteria. This returns the filtered records.

getEmploymentInfo

Operation: /hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/action/getEmploymentInfo

Finds areas of responsibility template records that match the specified advanced search criteria. This returns the filtered records.

getNewIdFromSeq

Operation: /hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/action/getNewIdFromSeq

Assigns next sequence number to responsibility name for directly-assigned people.

rollbackAutoProvisionJobOutput

Operation: /hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/action/rollbackAutoProvisionJobOutput

Restores previously autoprovisioned responsibilities for selected template.

scheduleAutoProvisionJob

Operation: /hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/action/scheduleAutoProvisionJob

Schedules autoprovisioning for a template.

updateAutoprovisionResponsibilities

Operation: /hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/action/updateAutoprovisionResponsibilities

Updates the autoprovisioned responsibilities for the current responsibility template, such as when end-dating, inactivating, or modifying content.

Back to Top