Jump to

• Request
• Response

Update a library goal task

patch

/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalTasks/{libraryGoalTasksUniqID}

Request

Path Parameters

• libraryGoalTasksUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- TaskContentId, BusinessGroupId and TaskId ---for the Library Goal Tasks resource and used to uniquely identify an instance of Library Goal Tasks. The client should not generate the hash key value. Instead, the client should query on the Library Goal Tasks collection resource with a filter on the primary key values in order to navigate to a specific instance of Library Goal Tasks.
  
  For example: libraryGoalTasks?q=TaskContentId=<value1>;BusinessGroupId=<value2>;TaskId=<value3>
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"Start date of the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaskTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Task type code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "PercentCompletion":{
            "maxLength":"30",
            "type":"string",
            "description":"Completion percentage of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"Target completion date for the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TaskName":{
            "title":"Name",
            "maxLength":"700",
            "type":"string",
            "description":"Name of the task of a library goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Comments":{
            "title":"Full Content Item Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Comments about the library goal task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PriorityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Priority code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "RelatedLink":{
            "maxLength":"4000",
            "type":"string",
            "description":"Related link of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "GoalId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the library goal for which the task applies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        }
    }
}

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 : libraryGoals-libraryGoalTasks-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the library goal task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the library goal task was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaskTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Task type code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the library goal task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Content Item Relationship ID",
            "type":"integer",
            "description":"Unique identifier for the task of a library goal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TaskContentId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Full Content Item Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Comments about the library goal task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PriorityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Priority code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status code of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaskTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Task type of the library goal's task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the library goal's task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PercentCompletion":{
            "maxLength":"30",
            "type":"string",
            "description":"Completion percentage of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"Target completion date for the library goal's task.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Name",
            "maxLength":"700",
            "type":"string",
            "description":"Name of the task of a library goal.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RelatedLink":{
            "maxLength":"4000",
            "type":"string",
            "description":"Related link of the library goal's task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessGroupId":{
            "title":"Business Group ID",
            "type":"integer",
            "description":"Unique identifier for the business group for which the library goal's task applies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PriorityMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Priority of the library goal's task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the library goal task was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GoalId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the library goal for which the task applies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "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