Jump to

• Request
• Response

Update an associated comment

patch

/fscmRestApi/resources/11.13.18.05/hedComments/{CommentId}

Request

Path Parameters

• CommentId(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

• Content: string (byte)
  Title: Content

  Content of the comment.
• PrivateFlag: boolean
  Title: Private

  Indicates whether the comment is private. If true a comment is only visible to the user who created it. If false, it displays to all users with access to view comments for the record.

{
    "type":"object",
    "properties":{
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"Content of the comment.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "PrivateFlag":{
            "title":"Private",
            "type":"boolean",
            "description":"Indicates whether the comment is private. If true a comment is only visible to the user who created it. If false, it displays to all users with access to view comments for the record.",
            "nullable":false,
            "x-hints":{
                "precision":1
            }
        }
    }
}

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

Type: object

Show Source

• CommenterFirstName: string
  Title: Commenter First Name

  Read Only: true

  Maximum Length: 150

  The first name of the commenter.
• CommenterFullName: string
  Title: Commenter Full Name

  Read Only: true

  Maximum Length: 360

  The full name of the commenter.
• CommenterLastName: string
  Title: Commenter Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the commenter.
• CommenterPartyId: integer (int64)
  Title: Commenter Party ID

  Read Only: true

  The unique party identifier of the commenter.
• CommentId: integer (int64)
  Title: Comment ID

  Read Only: true

  The unique identifier of a comment.
• Content: string (byte)
  Title: Content

  Content of the comment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The creation date of the comment.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last updated date of the comment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object the comment has a relationship to.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 32

  The object the comment has a relationship to.
• ObjectUpdateTime: string (date-time)
  Title: Object Update Date

  Read Only: true

  The date and time of the object update that the comment is relating to.
• ParentCommentId: integer (int64)
  Title: Parent Comment ID

  The unique identifier of the comment's parent comment. When a comment has a parent it's displayed as a reply.
• PrivateFlag: boolean
  Title: Private

  Indicates whether the comment is private. If true a comment is only visible to the user who created it. If false, it displays to all users with access to view comments for the record.
• SystemGeneratedFlag: boolean
  Title: System Generated

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the comment was created by the Student Management application. If true, an automated process generated the comment. If false, the comment was created by a person.

{
    "type":"object",
    "properties":{
        "CommentId":{
            "title":"Comment ID",
            "type":"integer",
            "description":"The unique identifier of a comment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommenterFirstName":{
            "title":"Commenter First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the commenter.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "CommenterFullName":{
            "title":"Commenter Full Name",
            "maxLength":360,
            "type":"string",
            "description":"The full name of the commenter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommenterLastName":{
            "title":"Commenter Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the commenter.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "CommenterPartyId":{
            "title":"Commenter Party ID",
            "type":"integer",
            "description":"The unique party identifier of the commenter.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Content":{
            "title":"Content",
            "type":"string",
            "description":"Content of the comment.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The creation date of the comment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last updated date of the comment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object the comment has a relationship to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":32,
            "type":"string",
            "description":"The object the comment has a relationship to.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectUpdateTime":{
            "title":"Object Update Date",
            "type":"string",
            "description":"The date and time of the object update that the comment is relating to.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCommentId":{
            "title":"Parent Comment ID",
            "type":"integer",
            "description":"The unique identifier of the comment's parent comment. When a comment has a parent it's displayed as a reply.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrivateFlag":{
            "title":"Private",
            "type":"boolean",
            "description":"Indicates whether the comment is private. If true a comment is only visible to the user who created it. If false, it displays to all users with access to view comments for the record.",
            "nullable":false,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "SystemGeneratedFlag":{
            "title":"System Generated",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the comment was created by the Student Management application. If true, an automated process generated the comment. If false, the comment was created by a person.",
            "nullable":false,
            "readOnly":true,
            "default":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