Jump to

• Request
• Response

Create a comment

post

/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments

Request

Path Parameters

• ObjectKey(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=

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CommentId: integer (int64)
  Identifier of the comment.
• CommentStatus: string
  Maximum Length: 64

  Status of the comment.
• CommentText: string
  Maximum Length: 2000

  Text in the comment.
• ObjectId: integer (int64)
  Identifier of the business object to which the comment belongs like assignment or person.
• ObjectVersionNumber: integer (int32)
  Object version number of the comment record.
• TaskId: string
  Maximum Length: 64

  Identifier of the task used to fetch comments.
• TransactionId: integer (int64)
  Identifier of the transaction used to fetch the comments.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "maxLength":"64",
            "type":"string",
            "description":"Identifier of the task used to fetch comments.",
            "nullable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Identifier of the business object to which the comment belongs like assignment or person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number of the comment record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "CommentText":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text in the comment.",
            "nullable":false
        },
        "CommentStatus":{
            "maxLength":"64",
            "type":"string",
            "description":"Status of the comment.",
            "nullable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"Identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransactionId":{
            "type":"integer",
            "description":"Identifier of the transaction used to fetch the comments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "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 : businessProcessApprovalAttachmentsComments-approvalComments-item-response

Type: object

Show Source

• CommentId: integer (int64)
  Identifier of the comment.
• CommentStatus: string
  Maximum Length: 64

  Status of the comment.
• CommentText: string
  Maximum Length: 2000

  Text in the comment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the comment.
• CreationDate: string (date-time)
  Read Only: true

  Comment creation date.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the comment was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the attachment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Sign in details of the user who last updated the comment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Identifier of the business object to which the comment belongs like assignment or person.
• ObjectVersionNumber: integer (int32)
  Object version number of the comment record.
• TaskId: string
  Maximum Length: 64

  Identifier of the task used to fetch comments.
• TransactionId: integer (int64)
  Identifier of the transaction used to fetch the comments.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Comment creation date.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "maxLength":"64",
            "type":"string",
            "description":"Identifier of the task used to fetch comments.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Identifier of the business object to which the comment belongs like assignment or person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CommentText":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text in the comment.",
            "nullable":false,
            "x-queryable":true
        },
        "CommentStatus":{
            "maxLength":"64",
            "type":"string",
            "description":"Status of the comment.",
            "nullable":true,
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"Identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Identifier of the transaction used to fetch the comments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number of the comment record.",
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the comment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Sign in details of the user who last updated the comment.",
            "nullable":true,
            "readOnly":true,
            "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