Jump to

• Request
• Response

Create a set of record comments

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorRecordComments-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

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

  The comment preview.
• CommentPuid(optional): string
  Maximum Length: 480

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

  The comment text.
• CreatedByName(optional): string
  Title: Created By

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

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

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

  The name of the user who last updated the comment.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): 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(optional): integer(int64)
  The unique identifier of the record.
• RecordNumber(optional): string
  Maximum Length: 64

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

  Maximum Length: 30

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

  Maximum Length: 1

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record comment."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The comment preview.",
            "title":"Comment Preview"
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique key identifier for the related data migration transaction."
        },
        "CommentText":{
            "type":"string",
            "description":"The comment text.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the comment.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the comment was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the comment was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the comment.",
            "title":"Last Updated By"
        },
        "LnpRecordId":{
            "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.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record."
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The parent record key for the data migration transaction."
        },
        "SubjectId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier to determine the type of comment such as a record, workflow, or inspection.",
            "title":"Subject"
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The checkbox to indicate if the comment will be visible to others.",
            "title":"Hide from Public"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorRecordComments-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

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

  The comment preview.
• CommentPuid(optional): string
  Maximum Length: 480

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

  The comment text.
• CreatedByName(optional): string
  Title: Created By

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

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

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

  The name of the user who last updated the comment.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): 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(optional): integer(int64)
  The unique identifier of the record.
• RecordNumber(optional): string
  Maximum Length: 64

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

  Maximum Length: 30

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

  Maximum Length: 1

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record comment."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The comment preview.",
            "title":"Comment Preview"
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique key identifier for the related data migration transaction."
        },
        "CommentText":{
            "type":"string",
            "description":"The comment text.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the comment.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the comment was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the comment was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the comment.",
            "title":"Last Updated By"
        },
        "LnpRecordId":{
            "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.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record."
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The parent record key for the data migration transaction."
        },
        "SubjectId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier to determine the type of comment such as a record, workflow, or inspection.",
            "title":"Subject"
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The checkbox to indicate if the comment will be visible to others.",
            "title":"Hide from Public"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top