Jump to

• Request
• Response

Update a single scope attribute for a specified responsibility template

patch

/hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/{TemplateId}/child/AoRTemplateScope/{TemplateDetailsId}

Request

Path Parameters

• TemplateDetailsId(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=
• 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

• 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

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

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "TemplateDetailsId":{
            "type":"integer",
            "description":"Surrogate identifier for a scope attribute of a template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "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"
        },
        "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"
                ]
            }
        },
        "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"
        },
        "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
        },
        "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"
        },
        "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"
            }
        },
        "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
        },
        "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"
        },
        "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"
        },
        "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
        },
        "DefaultValue4":{
            "maxLength":1000,
            "type":"string",
            "description":"Recruiting Org Tree Version attribute code when AttributeName is AOR_RECRUIT_ORG_HIER.",
            "nullable":true
        },
        "DefaultValue5":{
            "maxLength":1000,
            "type":"string",
            "description":"Number of hierarchy levels if you provided AttributeName of AOR_HIERARCHY_TYPE.",
            "nullable":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"
        }
    }
}

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-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 : 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."
        }
    }
}

Links

AttributeNameLovVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupCode%3D{AttributeName}%2CLookupType%3DORA_PER_AOR_TEMPLATE_ATTRIBUTE

The following properties are defined on the LOV link relation:

• Source Attribute: AttributeName; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top