Jump to

• Request
• Response

Update a record comment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}

Request

Path Parameters

• publicSectorRecordCommentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Record Comments resource and used to uniquely identify an instance of Record Comments. The client should not generate the hash key value. Instead, the client should query on the Record Comments collection resource in order to navigate to a specific instance of Record Comments 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

• CommentText: string (byte)
  Title: Comments

  The comment text.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

  The logical ID of the application record. This ID is generated based on the auto number rule configured for the record type.
• LnpRecordKey: integer (int64)
  The unique identifier of the record.
• RecordNumber: string
  Maximum Length: 64

  The parent record key for the data migration transaction.
• SubjectId: string
  Title: Subject

  Maximum Length: 30

  The unique identifier to determine the type of comment such as a record, workflow, or inspection.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  The checkbox to indicate if the comment will be visible to others.

{
    "type":"object",
    "properties":{
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"The logical ID of the application record. This ID is generated based on the auto number rule configured for the record type.",
            "nullable":false
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The comment text.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":"1",
            "type":"string",
            "description":"The checkbox to indicate if the comment will be visible to others.",
            "nullable":false,
            "default":"Y"
        },
        "SubjectId":{
            "title":"Subject",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier to determine the type of comment such as a record, workflow, or inspection.",
            "nullable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecordNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The parent record key for the data migration transaction.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the public sector agency.
• CommentId: integer (int64)
  The unique identifier of the record comment.
• CommentPreview: string
  Title: Comment Preview

  Read Only: true

  The comment preview.
• CommentPuid: string
  Maximum Length: 480

  The unique key identifier for the related data migration transaction.
• CommentText: string (byte)
  Title: Comments

  The comment text.
• CreatedByName: string
  Title: Created By

  Read Only: true

  The name of the user who created the comment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the comment was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the comment was last updated.
• LastUpdatedByName: string
  Title: Last Updated By

  Read Only: true

  The name of the user who last updated the comment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

  The logical ID of the application record. This ID is generated based on the auto number rule configured for the record type.
• LnpRecordKey: integer (int64)
  The unique identifier of the record.
• OriginalCreatedBy: string
  The name of the user who created the comment.
• RecordNumber: string
  Maximum Length: 64

  The parent record key for the data migration transaction.
• SubjectId: string
  Title: Subject

  Maximum Length: 30

  The unique identifier to determine the type of comment such as a record, workflow, or inspection.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  The checkbox to indicate if the comment will be visible to others.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the user who created the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the comment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"The logical ID of the application record. This ID is generated based on the auto number rule configured for the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"The comment preview.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the comment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The comment text.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"The unique identifier of the record comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The unique key identifier for the related data migration transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":"1",
            "type":"string",
            "description":"The checkbox to indicate if the comment will be visible to others.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubjectId":{
            "title":"Subject",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier to determine the type of comment such as a record, workflow, or inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The parent record key for the data migration transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the comment was last updated.",
            "format":"date-time",
            "nullable":false,
            "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