Jump to

• Request
• Response

Update details of a library goal

patch

/hcmRestApi/resources/11.13.18.05/libGoalTranslations/{libGoalTranslationsUniqID}

Request

Path Parameters

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

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

• ContentItemId: integer (int64)
  Unique identifier of the library goal for which details are required.
• Description: string
  Maximum Length: 4000

  Description of the library goal.
• Language: string
  Maximum Length: 4

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

  Name of the library goal.
• SuccessCriteria: string
  Maximum Length: 4000

  Success criteria of the library goal.

{
    "type":"object",
    "properties":{
        "ContentItemId":{
            "type":"integer",
            "description":"Unique identifier of the library goal for which details are required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the library goal.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "SuccessCriteria":{
            "maxLength":"4000",
            "type":"string",
            "description":"Success criteria of the library goal.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Unique identifier of the language required for the library goal.",
            "nullable":false
        },
        "Name":{
            "maxLength":"700",
            "type":"string",
            "description":"Name of the library goal.",
            "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 : libGoalTranslations-item-response

Type: object

Show Source

• BusinessGroupId: integer (int64)
  Unique identifier of the business group.
• ContentItemId: integer (int64)
  Unique identifier of the library goal for which details are required.
• Description: string
  Maximum Length: 4000

  Description of the library goal.
• Language: string
  Maximum Length: 4

  Unique identifier of the language required for the library goal.
• LanguageName: string
  Title: Language Name

  Read Only: true

  Maximum Length: 255

  Language for which goal details need to be displayed.
• LastUpdateDate: string (date-time)
  Read Only: true

  Latest date on which library goal details are modified.
• links: array Links
  Title: Links

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

  Name of the library goal.
• SuccessCriteria: string
  Maximum Length: 4000

  Success criteria of the library goal.

{
    "type":"object",
    "properties":{
        "ContentItemId":{
            "type":"integer",
            "description":"Unique identifier of the library goal for which details are required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the library goal.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Unique identifier of the language required for the library goal.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LanguageName":{
            "title":"Language Name",
            "maxLength":"255",
            "type":"string",
            "description":"Language for which goal details need to be displayed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessGroupId":{
            "type":"integer",
            "description":"Unique identifier of the business group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SuccessCriteria":{
            "maxLength":"4000",
            "type":"string",
            "description":"Success criteria of the library goal.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Latest date on which library goal details are modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"700",
            "type":"string",
            "description":"Name of the library goal.",
            "nullable":false,
            "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