Jump to

• Request
• Response

Update a post action tracking

patch

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeCommunityDetails/{EmployeeCommunityId}/child/posts/{EmployeeCommunityPostId}/child/postActionTracking/{ActionTrackingId}

Request

Path Parameters

• ActionTrackingId(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=
• EmployeeCommunityId(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=
• EmployeeCommunityPostId(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=

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

• ActionByPersonId: integer (int64)
  Identifier of the person who performed the action.
• ActionCount: number
  Count of actions taken on a post. This value represents the total number of interactions or engagements with the post.
• ActionDate: string (date-time)
  Date when the action was taken on the post.
• ActionTypeCode: string
  Maximum Length: 32

  Indicates the type of action taken on the post. Valid values are defined in the associated lookup.
• EmployeeCommunityPostId: integer (int64)
  Unique identifier for the employee community post.
• ObjectStatus: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  Indicates the current status of the object. Valid values are Active and Inactive. Default is Active.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the post action tracking object. This value helps in tracking changes to the object over time.

{
    "type":"object",
    "properties":{
        "ActionByPersonId":{
            "type":"integer",
            "description":"Identifier of the person who performed the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActionCount":{
            "type":"number",
            "description":"Count of actions taken on a post. This value represents the total number of interactions or engagements with the post.",
            "nullable":true
        },
        "ActionDate":{
            "type":"string",
            "description":"Date when the action was taken on the post.",
            "format":"date-time",
            "nullable":true
        },
        "ActionTypeCode":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates the type of action taken on the post. Valid values are defined in the associated lookup.",
            "nullable":true
        },
        "EmployeeCommunityPostId":{
            "type":"integer",
            "description":"Unique identifier for the employee community post.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the object. Valid values are Active and Inactive. Default is Active.",
            "nullable":true,
            "default":"ORA_ACTIVE"
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the post action tracking object. This value helps in tracking changes to the object over time.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

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 : communicateUIEmployeeCommunityDetails-posts-postActionTracking-item-response

Type: object

Show Source

• ActionByPersonId: integer (int64)
  Identifier of the person who performed the action.
• ActionCount: number
  Count of actions taken on a post. This value represents the total number of interactions or engagements with the post.
• ActionDate: string (date-time)
  Date when the action was taken on the post.
• ActionTrackingId: integer (int64)
  Unique identifier for the action tracking record in the employee community post.
• ActionTypeCode: string
  Maximum Length: 32

  Indicates the type of action taken on the post. Valid values are defined in the associated lookup.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Created by the user who initiated the post action tracking.
• CreationDate: string (date-time)
  Read Only: true

  Date when the post action was created.
• EmployeeCommunityPostId: integer (int64)
  Unique identifier for the employee community post.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last updated date of the post action tracking record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last updated by information for the post action tracking.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last updated login ID for the post action tracking record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectStatus: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  Indicates the current status of the object. Valid values are Active and Inactive. Default is Active.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the post action tracking object. This value helps in tracking changes to the object over time.

{
    "type":"object",
    "properties":{
        "ActionByPersonId":{
            "type":"integer",
            "description":"Identifier of the person who performed the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionCount":{
            "type":"number",
            "description":"Count of actions taken on a post. This value represents the total number of interactions or engagements with the post.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionDate":{
            "type":"string",
            "description":"Date when the action was taken on the post.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActionTrackingId":{
            "type":"integer",
            "description":"Unique identifier for the action tracking record in the employee community post.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionTypeCode":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates the type of action taken on the post. Valid values are defined in the associated lookup.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Created by the user who initiated the post action tracking.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the post action was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeCommunityPostId":{
            "type":"integer",
            "description":"Unique identifier for the employee community post.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date of the post action tracking record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last updated login ID for the post action tracking record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last updated by information for the post action tracking.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the object. Valid values are Active and Inactive. Default is Active.",
            "nullable":true,
            "default":"ORA_ACTIVE",
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the post action tracking object. This value helps in tracking changes to the object over time.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "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