Jump to

• Request
• Response
• Examples

Get all goal plans

get

/hcmRestApi/resources/11.13.18.05/goalPlansLOV

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 goal plans that match the primary key criteria specified.
    Finder Variables
    • GoalPlanId; integer; Unique identifier of the goal plan.
  • findByWord Finds all goal plans that match the specified word.
    Finder Variables
    • FilterAttributes; string; Filter attributes for the goal plans search.
    • SearchTerms; string; Search term criteria to find goal plans.
  • findGoalPlansForRPandAssignment Finds goal plans that match the specified review period and person assignment.
    Finder Variables
    • ManagerAssignmentId; integer; Unique identifier for the assignment of the manager.
    • ReviewPeriodId; integer; Unique identifier for the review period associated with the goal plan.
    • WorkerAssignmentId; integer; Unique identifier for the assignment of the person who's assigned the goal plan.
• 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:
  

  • AllowPvtGoalMaximumGoalFlag; boolean; Indicates if users can continue to add private goals after the goal plan has the maximum permitted goals.
  • ApprovalUsageContext; string; Usage context of the goal plan used to filter the goal plans based upon their phase in the goal plan approval life cycle.
  • EnableWeightingFlag; boolean; Indicates whether weights are enabled for the goals in the goal plan.
  • EndDate; string; End date of the goal plan.
  • EnforceGoalWeightFlag; boolean; Indicates if the sum of weights of goals in the goal plan can exceed 100% or not.
  • EnforceMaximumGoalsInGpFlag; boolean; Indicates if maximum goals in goal plan is enforced or not.
  • GoalAccessLevelCode; string; Code that specifies the roles that can access the goals in the goal plan.
  • GoalPlanId; integer; Unique identifier of the goal plan.
  • GoalPlanName; string; Name of the goal plan.
  • MaximumGoalsNumberInGoalPlan; integer; Maximum goals allowed in the goal plan.
  • PrimaryGoalPlanFlag; boolean; Indicates if the goal plan is the primary goal plan.
  • ReviewPeriodId; integer; Unique identifier of the review period associated with the goal plan.
  • StartDate; string; Start date of the goal plan.
  • Status; string; Status of the goal plan that indicates whether the goal plan is active or not.
• 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 : goalPlansLOV

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object goalPlansLOV-item-response

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

Type: object

Show Source

• AllowPvtGoalMaximumGoalFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates if users can continue to add private goals after the goal plan has the maximum permitted goals.
• ApprovalUsageContext: string
  Maximum Length: 255

  Default Value: NA

  Usage context of the goal plan used to filter the goal plans based upon their phase in the goal plan approval life cycle.
• EnableWeightingFlag: boolean
  Read Only: true

  Maximum Length: 30

  Default Value: true

  Indicates whether weights are enabled for the goals in the goal plan.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  End date of the goal plan.
• EnforceGoalWeightFlag: boolean
  Read Only: true

  Maximum Length: 30

  Default Value: false

  Indicates if the sum of weights of goals in the goal plan can exceed 100% or not.
• EnforceMaximumGoalsInGpFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates if maximum goals in goal plan is enforced or not.
• GoalAccessLevelCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: ALL

  Code that specifies the roles that can access the goals in the goal plan.
• GoalPlanId: integer (int64)
  Title: Goal Plan ID

  Read Only: true

  Unique identifier of the goal plan.
• GoalPlanName: string
  Title: Goal Plan Name

  Read Only: true

  Maximum Length: 400

  Name of the goal plan.
• links: array Links
  Title: Links

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

  Maximum goals allowed in the goal plan.
• PrimaryGoalPlanFlag: boolean
  Read Only: true

  Maximum Length: 30

  Default Value: false

  Indicates if the goal plan is the primary goal plan.
• ReviewPeriodId: integer (int64)
  Read Only: true

  Unique identifier of the review period associated with the goal plan.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Start date of the goal plan.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: A

  Status of the goal plan that indicates whether the goal plan is active or not.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the goal plan that indicates whether the goal plan is active or not.",
            "nullable":true,
            "readOnly":true,
            "default":"A",
            "x-queryable":true
        },
        "MaximumGoalsNumberInGoalPlan":{
            "type":"integer",
            "description":"Maximum goals allowed in the goal plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnforceMaximumGoalsInGpFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if maximum goals in goal plan is enforced or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalAccessLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that specifies the roles that can access the goals in the goal plan.",
            "nullable":true,
            "readOnly":true,
            "default":"ALL",
            "x-queryable":true
        },
        "AllowPvtGoalMaximumGoalFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if users can continue to add private goals after the goal plan has the maximum permitted goals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnforceGoalWeightFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the sum of weights of goals in the goal plan can exceed 100% or not.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the goal plan.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryGoalPlanFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the goal plan is the primary goal plan.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "EnableWeightingFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether weights are enabled for the goals in the goal plan.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the goal plan.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalUsageContext":{
            "maxLength":255,
            "type":"string",
            "description":"Usage context of the goal plan used to filter the goal plans based upon their phase in the goal plan approval life cycle.",
            "nullable":true,
            "default":"NA",
            "x-queryable":true
        },
        "GoalPlanId":{
            "title":"Goal Plan ID",
            "type":"integer",
            "description":"Unique identifier of the goal plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ReviewPeriodId":{
            "type":"integer",
            "description":"Unique identifier of the review period associated with the goal plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalPlanName":{
            "title":"Goal Plan Name",
            "maxLength":400,
            "type":"string",
            "description":"Name of the goal plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

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

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/goalPlansLOV

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK                     
Content-Type : application/json

Example of Response Body

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

{
  "items": [
    {
      "GoalPlanId": 300100010717736,
      "GoalPlanName": "ZHRG-AUT-Development Plan 201054841250",
      "StartDate": "2010-01-01",
      "EndDate": "2010-12-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 300100039978188,
      "GoalPlanName": "ZHRR-2014 Performance goal plan",
      "StartDate": "2009-08-01",
      "EndDate": "2020-12-01",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 300100040131045,
      "GoalPlanName": "ZHRA-Uptake GP 2013-2",
      "StartDate": "2013-01-01",
      "EndDate": "2013-12-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 300100046907111,
      "GoalPlanName": " FY2016 Performance Goals",
      "StartDate": "2015-06-01",
      "EndDate": "2016-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003001,
      "GoalPlanName": "ZHRG-2008-09 Performance Plan for HCM Development",
      "StartDate": "2008-06-01",
      "EndDate": "2009-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003002,
      "GoalPlanName": "ZHRG-2008-09 Development Plan for HCM Development",
      "StartDate": "2008-06-01",
      "EndDate": "2009-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003003,
      "GoalPlanName": "ZHRG-2009-10 Performance Plan for HCM Development",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003004,
      "GoalPlanName": "ZHRG-2009-10 Development Plan for HCM Development",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003005,
      "GoalPlanName": "ZHRG-2010-11 Development Plan for HCM TM Development",
      "StartDate": "2010-06-01",
      "EndDate": "2011-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003006,
      "GoalPlanName": "ZHRG-2010-11 Performance Plan for HCM TM Development",
      "StartDate": "2010-06-01",
      "EndDate": "2011-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003007,
      "GoalPlanName": "ZHRG-2011-12 Development Plan for HCM TM Development",
      "StartDate": "2011-06-01",
      "EndDate": "2012-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003008,
      "GoalPlanName": "ZHRG-2008-09 Performance Plan for HCM Goals Development",
      "StartDate": "2008-06-01",
      "EndDate": "2009-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003009,
      "GoalPlanName": "ZHRG-2008-09 Development Plan for HCM Goals Development",
      "StartDate": "2008-06-01",
      "EndDate": "2009-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003010,
      "GoalPlanName": "ZHRG-2009-10 Performance Plan for HCM Goals Development",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003011,
      "GoalPlanName": "ZHRG-2009-10 Development Plan for HCM Goals Development",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003012,
      "GoalPlanName": "ZHRG-2008-09 FusionQA Development plan for HCM",
      "StartDate": "2008-06-01",
      "EndDate": "2009-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003013,
      "GoalPlanName": "ZHRG-2008-09 Fusion QA Performance plan for HCM",
      "StartDate": "2008-06-01",
      "EndDate": "2009-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003014,
      "GoalPlanName": "ZHRG-2009-10 Performance Plan for HCM Localization Development",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003015,
      "GoalPlanName": "ZHRG-2009-10 Development Plan for HCM Localization Development",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003016,
      "GoalPlanName": "ZHRG-2009-10 Performance Plan for HCM IDC QA",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003017,
      "GoalPlanName": "ZHRG-2009-10 Performance Plan for HCM IDC Dev",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003018,
      "GoalPlanName": "ZHRG-2009-10 Performance Plan for IDC",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003019,
      "GoalPlanName": "ZHRG-2009-10 Development Plan for IDC",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003020,
      "GoalPlanName": "ZHRG-2009-10 Goal Plan for Deletion",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    },
    {
      "GoalPlanId": 95516003021,
      "GoalPlanName": "ZHRG-2009-10 QA Performance plan for APAC",
      "StartDate": "2009-06-01",
      "EndDate": "2010-05-31",
      "Status": "A",
      "links": [...]
    }
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
      "links": [...]
}

Back to Top