Create a library goal task
post
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalTasks
Request
Path Parameters
-
libraryGoalsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Library Goals resource and used to uniquely identify an instance of Library Goals. The client should not generate the hash key value. Instead, the client should query on the Library Goals collection resource in order to navigate to a specific instance of Library Goals 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
Root Schema : schema
Type:
Show Source
object
-
BusinessGroupId: integer
(int64)
Title:
Business Group ID
Unique identifier for the business group for which the library goal's task applies. -
Comments: string
Title:
Full Content Item Description
Maximum Length:4000
Comments about the library goal task. -
GoalId: integer
(int64)
Title:
Content Item ID
Unique identifier for the library goal for which the task applies. -
PercentCompletion: string
Maximum Length:
30
Completion percentage of the library goal's task. -
PriorityCode: string
Maximum Length:
30
Priority code of the library goal's task. -
RelatedLink: string
Maximum Length:
4000
Related link of the library goal's task. -
StartDate: string
(date)
Start date of the library goal's task.
-
StatusCode: string
Maximum Length:
30
Status code of the library goal's task. -
TargetCompletionDate: string
(date)
Target completion date for the library goal's task.
-
TaskContentId: integer
(int64)
Title:
Content Item ID
Unique identifier for the task of a library goal used to associate it with its components such as the task name, and task start date. -
TaskId: integer
(int64)
Title:
Content Item Relationship ID
Unique identifier for the task of a library goal. -
TaskName: string
Title:
Name
Maximum Length:700
Name of the task of a library goal. -
TaskTypeCode: string
Maximum Length:
30
Task type code of the library goal's task.
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.
Root Schema : libraryGoals-libraryGoalTasks-item-response
Type:
Show Source
object
-
BusinessGroupId: integer
(int64)
Title:
Business Group ID
Unique identifier for the business group for which the library goal's task applies. -
Comments: string
Title:
Full Content Item Description
Maximum Length:4000
Comments about the library goal task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the library goal task. -
CreationDate: string
(date-time)
Read Only:
true
Date when the library goal task was created. -
GoalId: integer
(int64)
Title:
Content Item ID
Unique identifier for the library goal for which the task applies. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the library goal task was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the library goal task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PercentCompletion: string
Maximum Length:
30
Completion percentage of the library goal's task. -
PriorityCode: string
Maximum Length:
30
Priority code of the library goal's task. -
PriorityMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Priority of the library goal's task. -
RelatedLink: string
Maximum Length:
4000
Related link of the library goal's task. -
StartDate: string
(date)
Start date of the library goal's task.
-
StatusCode: string
Maximum Length:
30
Status code of the library goal's task. -
StatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the library goal's task. -
TargetCompletionDate: string
(date)
Target completion date for the library goal's task.
-
TaskContentId: integer
(int64)
Title:
Content Item ID
Unique identifier for the task of a library goal used to associate it with its components such as the task name, and task start date. -
TaskId: integer
(int64)
Title:
Content Item Relationship ID
Unique identifier for the task of a library goal. -
TaskName: string
Title:
Name
Maximum Length:700
Name of the task of a library goal. -
TaskTypeCode: string
Maximum Length:
30
Task type code of the library goal's task. -
TaskTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Task type of the library goal's task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.