Jump to

• Request
• Response

Create a development goal

post

/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals

Request

Path Parameters

• devGoalsMassAssignProcessUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Development Goals Mass Assignment Process resource and used to uniquely identify an instance of Development Goals Mass Assignment Process. The client should not generate the hash key value. Instead, the client should query on the Development Goals Mass Assignment Process collection resource in order to navigate to a specific instance of Development Goals Mass Assignment Process to get the hash key.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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

  Actual completion date of development goal.
• 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.
• CategoryCode: string
  Title: Category

  Maximum Length: 30

  Category code of a development goal.
• Comments: string (byte)
  Title: Goal-specific Comments

  Comments for the development goal.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description for the development goal.
• GoalApprovalState: string
  Maximum Length: 30

  Approval state of the development goal.
• 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.
• LastModifiedDate: string (date-time)
  Title: Last Updated

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

  Maximum Length: 30

  Code that indicates the development goal level.
• 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.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  Default Value: MEDIUM

  Priority code 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.
• 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"
            }
        },
        "LastModifiedDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"Date the development goal was last modified.",
            "format":"date-time",
            "nullable":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"
            }
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Priority code of the development goal.",
            "nullable":true,
            "default":"MEDIUM",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrivateFlag":{
            "title":"Private",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the development goal is private or not.",
            "nullable":false,
            "default":false
        },
        "GoalApprovalState":{
            "maxLength":30,
            "type":"string",
            "description":"Approval state of the development goal.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the development goal.",
            "format":"date",
            "nullable":false
        },
        "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
        },
        "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
            }
        },
        "GoalVersionTypeCode":{
            "title":"Goal Version Type",
            "maxLength":30,
            "type":"string",
            "description":"Version code of the development goal.",
            "nullable":false,
            "default":"ACTIVE"
        },
        "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
        },
        "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
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Actual completion date of development goal.",
            "format":"date",
            "nullable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"Unique identifier for the development goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status code of the development goal.",
            "nullable":false,
            "default":"NOT_STARTED",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Comments":{
            "title":"Goal-specific Comments",
            "type":"string",
            "description":"Comments for the development goal.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuccessCriteria":{
            "title":"Success Criteria",
            "type":"string",
            "description":"Success criteria of the development goal.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ActiveFlag":{
            "title":"Status",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the development goal is active or not.",
            "nullable":true
        },
        "TargetCompletionDate":{
            "title":"Target Completion Date",
            "type":"string",
            "description":"Target completion date for the development goal.",
            "format":"date",
            "nullable":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
            }
        },
        "PercentComplete":{
            "title":"Completion Percentage",
            "maxLength":30,
            "type":"string",
            "description":"Goal completion percentage code.",
            "nullable":true
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":400,
            "type":"string",
            "description":"Name of the development goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

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 : devGoalsMassAssignProcess-devGoals-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

  Actual completion date of development goal.
• 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.
• 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.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date the development goal was created.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description for the development goal.
• GoalApprovalState: string
  Maximum Length: 30

  Approval state of the development goal.
• 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.
• 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.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the development goal.
• 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.
• 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.
• 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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date the development goal was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastModifiedDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"Date the development goal was last modified.",
            "format":"date-time",
            "nullable":true,
            "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
        },
        "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":"Approval state of the development goal.",
            "nullable":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
        },
        "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
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Actual completion date of development goal.",
            "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the development goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "Comments":{
            "title":"Goal-specific Comments",
            "type":"string",
            "description":"Comments for the development goal.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "PercentComplete":{
            "title":"Completion Percentage",
            "maxLength":30,
            "type":"string",
            "description":"Goal completion percentage code.",
            "nullable":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
        },
        "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

copyGoal

Operation: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/action/copyGoal

Parameters:

• GoalId: $request.path.GoalId
• devGoalsMassAssignProcessUniqID: $request.path.devGoalsMassAssignProcessUniqID

Copies the attributes of a development goal and creates a new development goal.

goalAssignAction

Operation: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/action/goalAssignAction

Parameters:

• GoalId: $request.path.GoalId
• devGoalsMassAssignProcessUniqID: $request.path.devGoalsMassAssignProcessUniqID

Assigns a development goal to the selected employees.

Back to Top