Jump to

• Request
• Response
• Examples

Get all plans

get

/hcmRestApi/resources/11.13.18.05/successionPlansLOV

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 all succession plans that match the primary key criteria specified.
    Finder Variables
    • PlanId; integer; Unique identifier for a succession plan.
  • findByWord Finds all succession plans that match the word specified.
    Finder Variables
    • FilterAttributes; string; Attributes for the search terms.
    • PersonId; integer; Person identifier of an employee that's used to retrieve all succession plans in which that employee isn't a candidate.
    • SearchTerms; string; Search term criteria to retrieve data.
    • StartsWithFlag; string; Indicator to retrieve data that starts with the search term.
    • TalentReviewMeetingId; integer; Unique identifier for a Talent Review meeting that's used to retrieve all succession plans that are added to 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; Level of access provided to the succession plan. The access can be administrator, who can view the plan, add and remove candidates and manage the plan, the candidate manager, who can view the plan, add and remove candidates, and the view role, which can only view the plan.
  • ObjectVersionNumber; integer; Version number of the succession plan.
  • Owners; string; Named owners of the plan.
  • PlanId; integer; Unique identifier for the succession plan.
  • PlanName; string; Name that uniquely identifies the succession plan.
  • PlanType; string; Type of succession plan.
  • PlanTypeMeaning; string; Description of the plan type.
  • Status; string; Status of the succession plan.
• 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 : successionPlansLOV

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object successionPlansLOV-item-response

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

Type: object

Show Source

• AccessTypeCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: PRIVATE

  Level of access provided to the succession plan. The access can be administrator, who can view the plan, add and remove candidates and manage the plan, the candidate manager, who can view the plan, add and remove candidates, and the view role, which can only view the plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Version number of the succession plan.
• Owners: string
  Named owners of the plan.
• PlanId: integer (int64)
  Read Only: true

  Unique identifier for the succession plan.
• PlanName: string
  Read Only: true

  Maximum Length: 400

  Name that uniquely identifies the succession plan.
• PlanType: string
  Read Only: true

  Maximum Length: 30

  Type of succession plan.
• PlanTypeMeaning: string
  Description of the plan type.
• Status: string
  Read Only: true

  Maximum Length: 30

  Status of the succession plan.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the succession plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanTypeMeaning":{
            "type":"string",
            "description":"Description of the plan type.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the succession plan.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier for the succession plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of succession plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccessTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Level of access provided to the succession plan. The access can be administrator, who can view the plan, add and remove candidates and manage the plan, the candidate manager, who can view the plan, add and remove candidates, and the view role, which can only view the plan.",
            "nullable":false,
            "readOnly":true,
            "default":"PRIVATE",
            "x-queryable":true
        },
        "PlanName":{
            "maxLength":"400",
            "type":"string",
            "description":"Name that uniquely identifies the succession plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Owners":{
            "type":"string",
            "description":"Named owners of the plan.",
            "nullable":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."
        }
    }
}

Back to Top

Examples

The following example shows how to get all plans by submitting a collection GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/successionPlansLOV?finder=findByWord;PersonId=300100180414808

Example of Response Header

The following is an example of the response header.

HTTP/1.1 201  Created
Created Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "PlanId": 300100026494869,
            "ObjectVersionNumber": 4,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "ZHRM FUSE Plan6",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Selina ZHRR-Ellis,Gavyn ZHRR-Fisher,Allen ZHRR-Taylor,Rajini ZHRR-Kanth",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100026495122,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM FUSE Plan13",
            "PlanType": "INCUMBENT",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100032503852,
            "ObjectVersionNumber": 2,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "Pramesh Soman Public Incumbent Plan",
            "PlanType": "INCUMBENT",
            "Status": "ACTIVE",
            "Owners": "Louise Beckham,Klaus Beckenbauer,Rajini ZHRR-Kanth",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100033135713,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM-PFT 1040131231_023600",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Matthew ZHRR-Clark,Emily ZHRR-Carter,Surya ZHRR-Kumar",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100017473842,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM Succession Plan for Frida Simmons",
            "PlanType": "INCUMBENT",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100033699947,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "ZHRM Succession Plan Public III",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100032503937,
            "ObjectVersionNumber": 3,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "Software Dev Sr Director Public Plan",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Meg Fitzimmons,Louise Beckham,Klaus Beckenbauer",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100033699909,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM Succession plan SP2_Country Security",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100033699935,
            "ObjectVersionNumber": 2,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "ZHRM Succession Plan Public II",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Jacob ZHRR-James",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100043640345,
            "ObjectVersionNumber": 3,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "ZHRM Public Meg Admin_Directs",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Meg Fitzimmons,Pramesh Soman",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100043640383,
            "ObjectVersionNumber": 2,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "ZHRM Public Meg Cand_Mgr_Directs",
            "PlanType": "INCUMBENT",
            "Status": "ACTIVE",
            "Owners": "Meg Fitzimmons,Pramesh Soman",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100026495188,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM FUSE Plan14",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter,Surya ZHRR-Kumar,Allen ZHRR-Taylor",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100026495079,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM FUSE Plan12",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100026495204,
            "ObjectVersionNumber": 2,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM FUSE Plan15",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Santino ZHRR-Foster,Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100026877765,
            "ObjectVersionNumber": 2,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "ZHRM RRF Succession plan I",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Zion ZHRR-Roberts",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100043640401,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "ZHRM Public Meg not owner_Directs",
            "PlanType": "JOB_FAMILY",
            "Status": "ACTIVE",
            "Owners": "Ravi Chouhan",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100043640416,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "ZHRM Public Meg Admin_No Directs",
            "PlanType": "JOB_PROFILE",
            "Status": "ACTIVE",
            "Owners": "Meg Fitzimmons",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100017156461,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM Succession Plan for Software Dev Manager",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100017156463,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM Succession Plan for Prod Manager",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100017156467,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM Succession Plan for Andrew Gonzales",
            "PlanType": "INCUMBENT",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100017156595,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM Succession Plan for Dev Team",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100017156674,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM Succession Plan for Ruby Mehta",
            "PlanType": "INCUMBENT",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100017156684,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM Succession Plan for Senior Manager",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100043640434,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PUBLIC",
            "PlanName": "ZHRM Public Meg Cand_Mgr _No Directs",
            "PlanType": "JOB",
            "Status": "ACTIVE",
            "Owners": "Meg Fitzimmons,Ravi Chouhan",
            "PlanTypeMeaning": null,
            "links": [...]
        },
        {
            "PlanId": 300100067729470,
            "ObjectVersionNumber": 1,
            "AccessTypeCode": "PRIVATE",
            "PlanName": "ZHRM Succession Plan for Nathen Diaz",
            "PlanType": "INCUMBENT",
            "Status": "ACTIVE",
            "Owners": "Emily ZHRR-Carter",
            "PlanTypeMeaning": null,
            "links": [...]
        }
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
            "links": [...]
}

Back to Top