Jump to

• Request
• Response

Get all development goals

get

/hcmRestApi/resources/11.13.18.05/searchDevGoals

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 the active and nonprivate development goals of a worker that match the primary key criteria specified.
    Finder Variables
    • GoalId; integer; Unique identifier for the development goal.
  • findByPersonId Finds all development goals for the specified person identifier.
    Finder Variables
    • GoalId; integer; Unique identifier for the development goal.
    • PersonId; integer; Unique identifier for the person whose development goals need to be retrieved.
  • findGoalByEvaluationId Finds a development goal in a specified performance document.
    Finder Variables
    • EvaluationId; integer; Unique identifier for the performance document that includes the development goals section.
    • GoalId; integer; Unique identifier for the development goal that's included in the performance document.
  • findGoalsForCheckInTopics Finds all active and nonprivate development goals of a worker that haven't been included in the check-in document of a specified check-in meeting.
    Finder Variables
    • CheckinMeetingId; integer; Unique identifier for the check-in meeting.
    • PersonId; integer; Unique identifier of the person for whom the check-in meeting is scheduled.
• 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:
  

  • ActiveFlag; boolean; Indicates if the development goal is active or not.
  • ActualCompletionDate; string; Date when the development goal was actually completed.
  • AllowKeyAttrUpdateFlag; boolean; Indicates if managers or workers can update the key attributes of a development goal.
  • AssignmentId; integer; Unique identifier for the assignment of the person who's assigned the development goal.
  • AssignmentName; string; Assignment name of the person who's assigned the development goal.
  • AssignmentNumber; string; Assignment number of the person who's assigned the development goal.
  • AssignmentType; string; Assignment type of the person who's assigned the development goal.
  • BusinessUnitId; integer; Unique identifier for the business unit of the person who's assigned the development goal.
  • BusinessUnitName; string; Name of the business unit of the person who's assigned the development goal.
  • CategoryCode; string; Category code of a development goal.
  • DepartmentId; integer; Unique identifier for the department of the person who's assigned the development goal.
  • DepartmentName; string; Name of the department of the person who's assigned the development goal.
  • DisplayName; string; Display name of the person who's assigned the development goal.
  • GoalApprovalState; string; Search Development Goals
  • GoalId; integer; Unique identifier for the development goal.
  • GoalName; string; Name of the development goal.
  • GoalSourceCode; string; Source code that indicates who created the development goal. A development goal can be created by a worker, a manager, or an HR specialist.
  • GoalVersionTypeCode; string; Version code of the development goal.
  • JobName; string; Job name of the person who's assigned the development goal.
  • LastModifiedBy; integer; User who last updated the development goal.
  • LastModifiedDate; string; Date the development goal was last modified.
  • LevelCode; string; Code that indicates the development goal level.
  • LocationId; integer; Unique identifier for the location of the person who's assigned the development goal.
  • LocationName; string; Name of the location of the person who's assigned the development goal.
  • MassRequestId; integer; Unique identifier for the mass assignment request for development goals.
  • PercentComplete; string; Goal completion percentage code.
  • PersonId; integer; Unique identifier for the person who's assigned the development goal.
  • PersonNumber; string; Person number of the person who's assigned the development goal.
  • PositionName; string; Position name of the person who's assigned the development goal.
  • PriorityCode; string; Priority code of the development goal.
  • PrivateFlag; boolean; Indicates if the development goal is private or not.
  • RequestContext; string; Indicates the flow from which the development goal was created. The goal could have been added from a Talent Review meeting or by mass assignment.
  • StartDate; string; Start date of the development goal.
  • Status; string; Status code of the development goal.
  • StatusMeaning; string; Meaning of status code of development goal.
  • TargetCompletionDate; string; Target completion date for the development goal.
• 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 : searchDevGoals

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object searchDevGoals-item-response

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

Type: object

Show Source

• ActiveFlag: boolean
  Title: Status

  Maximum Length: 30

  Indicates if the development goal is active or not.
• ActualCompletionDate: string (date)
  Title: Actual Completion Date

  Date when the development goal was actually completed.
• AllowKeyAttrUpdateFlag: boolean
  Title: Allow Workers to Update Key Attributes

  Maximum Length: 30

  Default Value: true

  Indicates if managers or workers can update the key attributes of a development goal.
• AssignmentId: integer (int64)
  Title: Assignment ID

  Unique identifier for the assignment of the person who's assigned the development goal.
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Assignment name of the person who's assigned the development goal.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Assignment number of the person who's assigned the development goal.
• AssignmentType: string
  Title: Assignment Type

  Read Only: true

  Maximum Length: 30

  Assignment type of the person who's assigned the development goal.
• BusinessUnitId: integer (int64)
  Read Only: true

  Unique identifier for the business unit of the person who's assigned the development goal.
• BusinessUnitName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Name of the business unit of the person who's assigned the development goal.
• CategoryCode: string
  Title: Category

  Maximum Length: 30

  Category code of a development goal.
• CategoryMeaning: string
  Title: Category

  Read Only: true

  Maximum Length: 80

  Category for the development goal.
• Comments: string (byte)
  Title: Goal-specific Comments

  Comments for the development goal.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the development goal.
• DepartmentId: integer (int64)
  Read Only: true

  Unique identifier for the department of the person who's assigned the development goal.
• DepartmentName: string
  Title: Department

  Read Only: true

  Maximum Length: 240

  Name of the department of the person who's assigned the development goal.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description for the development goal.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the person who's assigned the development goal.
• GoalApprovalState: string
  Maximum Length: 30

  Search Development Goals
• GoalId: integer (int64)
  Title: Goal ID

  Unique identifier for the development goal.
• GoalName: string
  Title: Goal Name

  Maximum Length: 400

  Name of the development goal.
• GoalSourceCode: string
  Title: Source

  Maximum Length: 30

  Source code that indicates who created the development goal. A development goal can be created by a worker, a manager, or an HR specialist.
• GoalVersionTypeCode: string
  Title: Goal Version Type

  Maximum Length: 30

  Default Value: ACTIVE

  Version code of the development goal.
• JobName: string
  Title: Job

  Read Only: true

  Maximum Length: 240

  Job name of the person who's assigned the development goal.
• LastModifiedBy: integer (int64)
  Title: Updated By

  User who last updated the development goal.
• LastModifiedDate: string (date-time)
  Title: Last Updated

  Date the development goal was last modified.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date the development goal was last updated.
• LevelCode: string
  Title: Level

  Maximum Length: 30

  Code that indicates the development goal level.
• LevelMeaning: string
  Title: Level

  Read Only: true

  Maximum Length: 80

  Level of the development goal.
• links: array Links
  Title: Links

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

  Unique identifier for the location of the person who's assigned the development goal.
• LocationName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 240

  Name of the location of the person who's assigned the development goal.
• MassRequestId: integer (int64)
  Unique identifier for the mass assignment request for development goals.
• PercentComplete: string
  Title: Completion Percentage

  Maximum Length: 30

  Goal completion percentage code.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier for the person who's assigned the development goal.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the person who's assigned the development goal.
• PositionName: string
  Title: Position

  Read Only: true

  Maximum Length: 240

  Position name of the person who's assigned the development goal.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  Default Value: MEDIUM

  Priority code of the development goal.
• PriorityMeaning: string
  Title: Priority

  Read Only: true

  Maximum Length: 80

  Priority of the development goal.
• PrivateFlag: boolean
  Title: Private

  Maximum Length: 30

  Default Value: false

  Indicates if the development goal is private or not.
• RequestContext: string
  Maximum Length: 30

  Indicates the flow from which the development goal was created. The goal could have been added from a Talent Review meeting or by mass assignment.
• RequiresApprovalStatus: string
  Indicates if the development goal needs to be approved.
• StartDate: string (date)
  Title: Start Date

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

  Maximum Length: 30

  Default Value: NOT_STARTED

  Status code of the development goal.
• StatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of status code of development goal.
• SuccessCriteria: string (byte)
  Title: Success Criteria

  Success criteria of the development goal.
• TargetCompletionDate: string (date)
  Title: Target Completion Date

  Target completion date for the development goal.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category code of a development goal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastModifiedDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"Date the development goal was last modified.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastModifiedBy":{
            "title":"Updated By",
            "type":"integer",
            "description":"User who last updated the development goal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description for the development goal.",
            "nullable":true,
            "x-queryable":false
        },
        "LevelCode":{
            "title":"Level",
            "maxLength":30,
            "type":"string",
            "description":"Code that indicates the development goal level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Priority code of the development goal.",
            "nullable":true,
            "default":"MEDIUM",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobName":{
            "title":"Job",
            "maxLength":240,
            "type":"string",
            "description":"Job name of the person who's assigned the development goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrivateFlag":{
            "title":"Private",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the development goal is private or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LevelMeaning":{
            "title":"Level",
            "maxLength":80,
            "type":"string",
            "description":"Level of the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "GoalApprovalState":{
            "maxLength":30,
            "type":"string",
            "description":"Search Development Goals",
            "nullable":true,
            "x-queryable":true
        },
        "LocationName":{
            "title":"Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location of the person who's assigned the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the development goal.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "GoalSourceCode":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"Source code that indicates who created the development goal. A development goal can be created by a worker, a manager, or an HR specialist.",
            "nullable":false,
            "x-queryable":true
        },
        "RequiresApprovalStatus":{
            "type":"string",
            "description":"Indicates if the development goal needs to be approved.",
            "nullable":true,
            "x-queryable":false
        },
        "MassRequestId":{
            "type":"integer",
            "description":"Unique identifier for the mass assignment request for development goals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the person who's assigned the development goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the person who's assigned the development goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier for the assignment of the person who's assigned the development goal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GoalVersionTypeCode":{
            "title":"Goal Version Type",
            "maxLength":30,
            "type":"string",
            "description":"Version code of the development goal.",
            "nullable":false,
            "default":"ACTIVE",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowKeyAttrUpdateFlag":{
            "title":"Allow Workers to Update Key Attributes",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if managers or workers can update the key attributes of a development goal.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "RequestContext":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the flow from which the development goal was created. The goal could have been added from a Talent Review meeting or by mass assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit of the person who's assigned the development goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Date when the development goal was actually completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"Unique identifier for the development goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the person who's assigned the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status code of the development goal.",
            "nullable":false,
            "default":"NOT_STARTED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PositionName":{
            "title":"Position",
            "maxLength":240,
            "type":"string",
            "description":"Position name of the person who's assigned the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Goal-specific Comments",
            "type":"string",
            "description":"Comments for the development goal.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier for the business unit of the person who's assigned the development goal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the location of the person who's assigned the development goal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SuccessCriteria":{
            "title":"Success Criteria",
            "type":"string",
            "description":"Success criteria of the development goal.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryMeaning":{
            "title":"Category",
            "maxLength":80,
            "type":"string",
            "description":"Category for the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActiveFlag":{
            "title":"Status",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the development goal is active or not.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of status code of development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "title":"Target Completion Date",
            "type":"string",
            "description":"Target completion date for the development goal.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier for the person who's assigned the development goal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":80,
            "type":"string",
            "description":"Assignment name of the person who's assigned the development goal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PercentComplete":{
            "title":"Completion Percentage",
            "maxLength":30,
            "type":"string",
            "description":"Goal completion percentage code.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":30,
            "type":"string",
            "description":"Assignment type of the person who's assigned the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":240,
            "type":"string",
            "description":"Name of the department of the person who's assigned the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":400,
            "type":"string",
            "description":"Name of the development goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DepartmentId":{
            "type":"integer",
            "description":"Unique identifier for the department of the person who's assigned the development goal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriorityMeaning":{
            "title":"Priority",
            "maxLength":80,
            "type":"string",
            "description":"Priority of the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date the development goal 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

createGoalIntents

Operation: /hcmRestApi/resources/11.13.18.05/searchDevGoals/action/createGoalIntents

Creates personal intents for a development goal.

findByAdvancedSearchQuery

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

Finds development goals that match the specified criteria.

getDevelopmentGoalDetails

Operation: /hcmRestApi/resources/11.13.18.05/searchDevGoals/action/getDevelopmentGoalDetails

Gets details of a development goal.

getDevelopmentLibraryGoalDetails

Operation: /hcmRestApi/resources/11.13.18.05/searchDevGoals/action/getDevelopmentLibraryGoalDetails

Gets all details of the specified development library goal.

prepareApprovalTxnForSubmission

Operation: /hcmRestApi/resources/11.13.18.05/searchDevGoals/action/prepareApprovalTxnForSubmission

Clears existing comments and removes files attached to the development goals approval request.

saveDevGoalApproval

Operation: /hcmRestApi/resources/11.13.18.05/searchDevGoals/action/saveDevGoalApproval

Saves data of a development goal and its associated tasks and measurements for processing approvals.

submitEss

Operation: /hcmRestApi/resources/11.13.18.05/searchDevGoals/action/submitEss

Submits mass assignment process for development goals that matches the specified mass assignment request ID.

Back to Top