Jump to

• Request
• Response

Get all succession plans

get

/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans

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 succession plans that match the primary key criteria specified.
    Finder Variables
    • PlanId; integer; Unique identifier for the succession plan.
  • findPlansNotInMeeting Finds all accessible succession plans that aren't part of the specified talent review meeting.
    Finder Variables
    • TalentReviewMeetingId; integer; Unique identifier for the talent review meeting.
• 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:
  

  • AccessTypeCode; string; Access type code of succession plan. Valid values are defined in the HRM_SUCC_ACCESS_TYPE lookup.
  • ActiveCandidatesCount; integer; Count of active candidates in a succession plan.
  • IncumbentCount; integer; Count of incumbents for a succession plan.
  • IncumbentDisplayName; string; Display name of the incumbent of the succession plan.
  • IncumbentIdentifier; string; Unique identifier for the succession plan incumbent. The value is the job name for Job type succession plan, position name for Position type succession plan, and the incumbent person's display name for Incumbent type plan.
  • IncumbentPersonId; integer; Unique person identifier for the incumbent.
  • InterimCandidateCount; integer; Count of interim candidates in a succession plan.
  • JobId; integer; Unique identifier for the job associated with the succession plan.
  • JobName; string; Name of the job associated with the succession plan.
  • ListOfIncumbents; string; List of incumbents for a succession plan.
  • ListOfOwners; string; Owners of the succession plan.
  • LoggedInUserAccess; string; Logged in person's access information for succession plans.
  • OwnerCount; integer; Count of succession plan owners.
  • PlanId; integer; Unique identifier for the succession plan.
  • PlanName; string; Name of succession plan.
  • PlanTypeCode; string; Plan type code of succession plan. Valid values are defined in the HRM_SUCC_PLAN_TYPE lookup.
  • PlanTypeMeaning; string; Type of succession plan.
  • PositionId; integer; Unique identifier for the position associated with the succession plan.
  • PositionName; string; Name of the position associated with the succession plan.
  • StatusCode; string; Status code of succession plan. Valid values are defined in the HRM_SUCC_PLAN_STATUS lookup.
• 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 : talentEquivalentSuccessionPlans

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/talentEquivalentSuccessionPlans-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object talentEquivalentSuccessionPlans-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/talentEquivalentSuccessionPlans-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 : talentEquivalentSuccessionPlans-item-response

Type: object

Show Source

• AccessTypeCode: string
  Title: Private

  Maximum Length: 30

  Default Value: PUBLIC

  Access type code of succession plan. Valid values are defined in the HRM_SUCC_ACCESS_TYPE lookup.
• AccessTypeMeaning: string
  Title: Access Type

  Read Only: true

  Maximum Length: 80

  Access type for succession plan. The access type determines if the succession plan can be accessed only by the named owners or also by persons who have access to the named or inferred incumbent of the plan.
• ActiveCandidatesCount: integer
  Title: Active Candidates

  Read Only: true

  Count of active candidates in a succession plan.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Unique identifier for the business unit associated with the succession plan.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 240

  Name of the business unit associated with the succession plan.
• CandidateRoleChangeAlertFlag: boolean
  Title: Send alerts when candidates move to roles that are different from the plan role

  Maximum Length: 255

  Indicates if alerts must be sent when a candidate moves to a role different from the role of the succession plan.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the succession plan.
• CreatedByListName: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  Name of the person who created the succession plan.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the succession plan was created.
• DepartmentId: integer (int64)
  Title: Department ID

  Unique identifier for the department associated with the succession plan.
• DepartmentName: string
  Title: Department

  Maximum Length: 240

  Name of the department associated with the succession plan.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description of succession plan.
• GradeCode: string
  Title: Grade Code

  Maximum Length: 30

  Code for the job grade associated with the succession plan.
• GradeId: integer (int64)
  Title: Grade ID

  Unique identifier for the job grade associated with the succession plan.
• GradeName: string
  Title: Job Grade

  Read Only: true

  Maximum Length: 240

  Name of the job grade associated with the succession plan.
• IncumbentAssignmentName: string
  Title: Incumbent's Business Title

  Read Only: true

  Maximum Length: 80

  Name of the assignment of the succession plan's incumbent.
• IncumbentCount: integer
  Title: Incumbent Count

  Read Only: true

  Count of incumbents for a succession plan.
• IncumbentDepartmentId: integer (int64)
  Title: Incumbent's Department ID

  Read Only: true

  Unique identifier for the department associated with the succession plan's incumbent.
• IncumbentDepartmentName: string
  Title: Incumbent's Department

  Read Only: true

  Maximum Length: 240

  Name of the incumbent's department.
• IncumbentDisplayName: string
  Title: Incumbent

  Read Only: true

  Maximum Length: 240

  Display name of the incumbent of the succession plan.
• IncumbentIdentifier: string
  Title: Incumbent

  Read Only: true

  Maximum Length: 255

  Unique identifier for the succession plan incumbent. The value is the job name for Job type succession plan, position name for Position type succession plan, and the incumbent person's display name for Incumbent type plan.
• IncumbentJobChangeAlertFlag: boolean
  Title: Send alerts when the succession plan incumbent changes roles

  Maximum Length: 255

  Indicates if alerts must be sent when the role of the incumbent of the succession plan changes.
• IncumbentJobCode: string
  Title: Incumbent's Job Code

  Read Only: true

  Maximum Length: 30

  Code for the job of the incumbent.
• IncumbentJobId: integer (int64)
  Title: Incumbent's Job ID

  Read Only: true

  Unique identifier for the job of the incumbent.
• IncumbentJobName: string
  Title: Incumbent's Job

  Read Only: true

  Maximum Length: 240

  Name of the incumbent's job.
• IncumbentPersonId: integer (int64)
  Title: Incumbent Person ID

  Unique person identifier for the incumbent.
• IncumbentPersonNumber: string
  Title: Incumbent's Person Number

  Maximum Length: 30

  Person number of the incumbent.
• IncumbentRoleChangeBannerFlag: boolean
  Title: Show incumbent role change banner

  Maximum Length: 1

  Indicates if a banner needs to be displayed when the role of the incumbent of the succession plan changes.
• InterimCandidateCount: integer
  Title: Interim Successors

  Read Only: true

  Count of interim candidates in a succession plan.
• JobCode: string
  Title: Job Code

  Maximum Length: 30

  Code for the job associated with the succession plan.
• JobFamilyId: integer (int64)
  Title: Job Family ID

  Unique identifier for the job family associated with the succession plan.
• JobId: integer (int64)
  Title: Job ID

  Unique identifier for the job associated with the succession plan.
• JobName: string
  Title: Job

  Read Only: true

  Maximum Length: 240

  Name of the job associated with the succession plan.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the succession plan was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the succession plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListOfIncumbents: string
  Title: Incumbents

  Read Only: true

  Maximum Length: 255

  List of incumbents for a succession plan.
• ListOfOwners: string
  Title: Owners

  Read Only: true

  Maximum Length: 255

  Owners of the succession plan.
• LoggedInUserAccess: string
  Read Only: true

  Maximum Length: 255

  Logged in person's access information for succession plans.
• OwnerCount: integer
  Title: Owner Count

  Read Only: true

  Count of succession plan owners.
• PlanId: integer (int64)
  Title: Plan ID

  Read Only: true

  Unique identifier for the succession plan.
• PlanName: string
  Title: Name

  Maximum Length: 400

  Name of succession plan.
• PlanTypeCode: string
  Title: Plan Type Code

  Maximum Length: 30

  Plan type code of succession plan. Valid values are defined in the HRM_SUCC_PLAN_TYPE lookup.
• PlanTypeMeaning: string
  Title: Plan Type

  Read Only: true

  Maximum Length: 80

  Type of succession plan.
• PositionCode: string
  Title: Position Code

  Maximum Length: 30

  Code for the position associated with the succession plan.
• PositionId: integer (int64)
  Title: Position ID

  Unique identifier for the position associated with the succession plan.
• PositionName: string
  Title: Position

  Read Only: true

  Maximum Length: 240

  Name of the position associated with the succession plan.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  Status code of succession plan. Valid values are defined in the HRM_SUCC_PLAN_STATUS lookup.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of succession plan that indicates if the plan is active or inactive.
• SuccessorAlertFlag: boolean
  Title: Send alerts when candidates move to the plan role

  Maximum Length: 255

  Indicates if alerts must be sent when a candidate moves to the role defined in the succession plan.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the succession plan was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessTypeMeaning":{
            "title":"Access Type",
            "maxLength":"80",
            "type":"string",
            "description":"Access type for succession plan. The access type determines if the succession plan can be accessed only by the named owners or also by persons who have access to the named or inferred incumbent of the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedByListName":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the person who created the succession plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanTypeCode":{
            "title":"Plan Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Plan type code of succession plan. Valid values are defined in the HRM_SUCC_PLAN_TYPE lookup.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status code of succession plan. Valid values are defined in the HRM_SUCC_PLAN_STATUS lookup.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CandidateRoleChangeAlertFlag":{
            "title":"Send alerts when candidates move to roles that are different from the plan role",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if alerts must be sent when a candidate moves to a role different from the role of the succession plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EnableAlerts"
                ]
            }
        },
        "PlanTypeMeaning":{
            "title":"Plan Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type of succession plan.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PlanTypeCode"
                ]
            },
            "x-queryable":true
        },
        "GradeCode":{
            "title":"Grade Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the job grade associated with the succession plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "GradeId"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PositionCode":{
            "title":"Position Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the position associated with the succession plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PositionId"
                ]
            }
        },
        "IncumbentAssignmentName":{
            "title":"Incumbent's Business Title",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the assignment of the succession plan's incumbent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the succession plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "IncumbentPersonId":{
            "title":"Incumbent Person ID",
            "type":"integer",
            "description":"Unique person identifier for the incumbent.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncumbentPersonNumber":{
            "title":"Incumbent's Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Person number of the incumbent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "IncumbentPersonId"
                ]
            }
        },
        "IncumbentDepartmentName":{
            "title":"Incumbent's Department",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the incumbent's department.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "IncumbentDepartmentId"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the succession plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PositionName":{
            "title":"Position",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the position associated with the succession plan.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PositionId"
                ]
            },
            "x-queryable":true
        },
        "InterimCandidateCount":{
            "title":"Interim Successors",
            "type":"integer",
            "description":"Count of interim candidates in a succession plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Unique identifier for the business unit associated with the succession plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncumbentJobChangeAlertFlag":{
            "title":"Send alerts when the succession plan incumbent changes roles",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if alerts must be sent when the role of the incumbent of the succession plan changes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EnableAlerts"
                ]
            }
        },
        "IncumbentDisplayName":{
            "title":"Incumbent",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the incumbent of the succession plan.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "IncumbentPersonId"
                ]
            },
            "x-queryable":true
        },
        "JobFamilyId":{
            "title":"Job Family ID",
            "type":"integer",
            "description":"Unique identifier for the job family associated with the succession plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "GradeName":{
            "title":"Job Grade",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the job grade associated with the succession plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "GradeId"
                ]
            }
        },
        "IncumbentJobCode":{
            "title":"Incumbent's Job Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the job of the incumbent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "IncumbentJobId"
                ]
            }
        },
        "IncumbentDepartmentId":{
            "title":"Incumbent's Department ID",
            "type":"integer",
            "description":"Unique identifier for the department associated with the succession plan's incumbent.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "IncumbentPersonId"
                ]
            }
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the department associated with the succession plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DepartmentId"
                ]
            }
        },
        "OwnerCount":{
            "title":"Owner Count",
            "type":"integer",
            "description":"Count of succession plan owners.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoggedInUserAccess":{
            "maxLength":"255",
            "type":"string",
            "description":"Logged in person's access information for succession plans.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of succession plan.",
            "nullable":true,
            "x-queryable":false
        },
        "JobName":{
            "title":"Job",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the job associated with the succession plan.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "JobId"
                ]
            },
            "x-queryable":true
        },
        "PlanName":{
            "title":"Name",
            "maxLength":"400",
            "type":"string",
            "description":"Name of succession plan.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AccessTypeCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"Access type code of succession plan. Valid values are defined in the HRM_SUCC_ACCESS_TYPE lookup.",
            "nullable":false,
            "default":"PUBLIC",
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ListOfIncumbents":{
            "title":"Incumbents",
            "maxLength":"255",
            "type":"string",
            "description":"List of incumbents for a succession plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the job associated with the succession plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "JobId"
                ]
            }
        },
        "GradeId":{
            "title":"Grade ID",
            "type":"integer",
            "description":"Unique identifier for the job grade associated with the succession plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit associated with the succession plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IncumbentIdentifier":{
            "title":"Incumbent",
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the succession plan incumbent. The value is the job name for Job type succession plan, position name for Position type succession plan, and the incumbent person's display name for Incumbent type plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier for the job associated with the succession plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncumbentJobId":{
            "title":"Incumbent's Job ID",
            "type":"integer",
            "description":"Unique identifier for the job of the incumbent.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "IncumbentPersonId"
                ]
            }
        },
        "IncumbentCount":{
            "title":"Incumbent Count",
            "type":"integer",
            "description":"Count of incumbents for a succession plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionId":{
            "title":"Position ID",
            "type":"integer",
            "description":"Unique identifier for the position associated with the succession plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanId":{
            "title":"Plan ID",
            "type":"integer",
            "description":"Unique identifier for the succession plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ListOfOwners":{
            "title":"Owners",
            "maxLength":"255",
            "type":"string",
            "description":"Owners of the succession plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncumbentJobName":{
            "title":"Incumbent's Job",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the incumbent's job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "IncumbentJobId"
                ]
            }
        },
        "IncumbentRoleChangeBannerFlag":{
            "title":"Show incumbent role change banner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if a banner needs to be displayed when the role of the incumbent of the succession plan changes.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of succession plan that indicates if the plan is active or inactive.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "ActiveCandidatesCount":{
            "title":"Active Candidates",
            "type":"integer",
            "description":"Count of active candidates in a succession plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuccessorAlertFlag":{
            "title":"Send alerts when candidates move to the plan role",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if alerts must be sent when a candidate moves to the role defined in the succession plan.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EnableAlerts"
                ]
            }
        },
        "DepartmentId":{
            "title":"Department ID",
            "type":"integer",
            "description":"Unique identifier for the department associated with the succession plan.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the succession plan was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

aiCandidateRecommendations

Operation: /hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/action/aiCandidateRecommendations

Gets artificial intelligence based candidate suggestions for a succession plan.

findByAdvancedSearchQuery

Operation: /hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/action/findByAdvancedSearchQuery

Finds succession plans based on advanced query parameters.

getInCurrentJobSinceOfWorker

Operation: /hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/action/getInCurrentJobSinceOfWorker

Gets start date for the current job of the succession plan candidate.

Back to Top