Jump to

• Request
• Response

Update details of a library goal task

patch

/hcmRestApi/resources/11.13.18.05/libGoalTaskTranslations/{libGoalTaskTranslationsUniqID}

Request

Path Parameters

• libGoalTaskTranslationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ContentItemId, BusinessGroupId and Language ---for the Library Goal Task Translations resource and used to uniquely identify an instance of Library Goal Task Translations. The client should not generate the hash key value. Instead, the client should query on the Library Goal Task Translations collection resource with a filter on the primary key values in order to navigate to a specific instance of Library Goal Task Translations.
  
  For example: libGoalTaskTranslations?q=ContentItemId=<value1>;BusinessGroupId=<value2>;Language=<value3>

Header Parameters

• Metadata-Context: string
  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: string
  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
  Maximum Length: 4000

  Comments for the library goal task.
• ContentItemId: integer (int64)
  Unique identifier of the library goal task for which details are required.
• Language: string
  Maximum Length: 4

  Unique identifier of the language required for the library goal.
• TaskName: string
  Maximum Length: 700

  Name of the library goal task.

{
    "type":"object",
    "properties":{
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments for the library goal task.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "ContentItemId":{
            "type":"integer",
            "description":"Unique identifier of the library goal task for which details are required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Unique identifier of the language required for the library goal.",
            "nullable":false
        },
        "TaskName":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the library goal task.",
            "nullable":false
        }
    }
}

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 : libGoalTaskTranslations-item-response

Type: object

Show Source

• BusinessGroupId: integer (int64)
  Unique identifier of the business group.
• Comments: string
  Maximum Length: 4000

  Comments for the library goal task.
• ContentItemId: integer (int64)
  Unique identifier of the library goal task for which details are required.
• GoalId: integer (int64)
  Title: Content Item ID

  Read Only: true

  Unique identifier of the library goal for which task details are required.
• Language: string
  Maximum Length: 4

  Unique identifier of the language required for the library goal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TaskName: string
  Maximum Length: 700

  Name of the library goal task.

{
    "type":"object",
    "properties":{
        "BusinessGroupId":{
            "type":"integer",
            "description":"Unique identifier of the business group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments for the library goal task.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "ContentItemId":{
            "type":"integer",
            "description":"Unique identifier of the library goal task for which details are required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GoalId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier of the library goal for which task details are required.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Unique identifier of the language required for the library goal.",
            "nullable":false,
            "x-queryable":true
        },
        "TaskName":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the library goal task.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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