Jump to

• Request
• Response

Update a like

patch

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/likes/{likeId}

Request

Path Parameters

• activeLearnerCommentsUniqID(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• completionDetailsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Completion Details resource and used to uniquely identify an instance of Completion Details. The client should not generate the hash key value. Instead, the client should query on the Completion Details collection resource in order to navigate to a specific instance of Completion Details to get the hash key.
• learnerLearningRecordsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Learner Learning Records resource and used to uniquely identify an instance of Learner Learning Records. The client should not generate the hash key value. Instead, the client should query on the Learner Learning Records collection resource in order to navigate to a specific instance of Learner Learning Records to get the hash key.
• likeId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• otherSelectedCourseOfferingsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Selected Course Offerings resource and used to uniquely identify an instance of Selected Course Offerings. The client should not generate the hash key value. Instead, the client should query on the Selected Course Offerings collection resource in order to navigate to a specific instance of Selected Course Offerings 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

• likeStatus: string
  Title: Like Status

  Maximum Length: 30

  Status for the comment like. Valid values are defined in the LikeStatusLOV list.

{
    "type":"object",
    "properties":{
        "likeStatus":{
            "title":"Like Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status for the comment like. Valid values are defined in the LikeStatusLOV list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-response

Type: object

Show Source

• byPersonDisplayName: string
  Title: Liked By

  Read Only: true

  Maximum Length: 240

  Display name for the comment liker.
• byPersonId: integer (int64)
  Title: Liked by Person ID

  Read Only: true

  Person identifier for the comment liker.
• byPersonImageURL: string
  Title: Liked by Person Image URL

  Read Only: true

  Maximum Length: 4000

  Image URL for the comment liker.
• byPersonNumber: string
  Title: Liked by Person Number

  Read Only: true

  Maximum Length: 30

  Person number for the comment liker.
• likeDate: string (date-time)
  Title: Liked on Date

  Read Only: true

  Date of the comment like.
• likeId: integer (int64)
  Title: Like ID

  Unique identifier for the like.
• likeStatus: string
  Title: Like Status

  Maximum Length: 30

  Status for the comment like. Valid values are defined in the LikeStatusLOV list.
• likeStatusMeaning: string
  Title: Like Status Description

  Read Only: true

  Description of the likeStatus attribute value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "byPersonDisplayName":{
            "title":"Liked By",
            "maxLength":"240",
            "type":"string",
            "description":"Display name for the comment liker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "byPersonImageURL":{
            "title":"Liked by Person Image URL",
            "maxLength":"4000",
            "type":"string",
            "description":"Image URL for the comment liker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "byPersonNumber":{
            "title":"Liked by Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Person number for the comment liker.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "likeDate":{
            "title":"Liked on Date",
            "type":"string",
            "description":"Date of the comment like.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "likeId":{
            "title":"Like ID",
            "type":"integer",
            "description":"Unique identifier for the like.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "likeStatusMeaning":{
            "title":"Like Status Description",
            "type":"string",
            "description":"Description of the likeStatus attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "likeStatus":{
            "title":"Like Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status for the comment like. Valid values are defined in the LikeStatusLOV list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "byPersonId":{
            "title":"Liked by Person ID",
            "type":"integer",
            "description":"Person identifier for the comment liker.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "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."
        }
    }
}

Links

LikeStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_SOCIAL_EVT_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: likeStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top