Jump to

• Request
• Response

Create a workflow comment

post

/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments

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 : publicSectorPcsComments-item

Type: object

Discriminator: PcsCommentType

Show Source

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

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

  This field is used to show the preview of the entered comments. It is usually the first 100-200 characters of the comment, which is a configurable number.
• CommentText(optional): string
  Title: Comments

  The comment that has been entered by the user.
• CreatedByName(optional): string
  Title: Created By

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

  The date on which the comment was added.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date on which the most recent update to the comment was made.
• LastUpdatedByName(optional): string
  Title: Last Updated By

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

  Link Relations
• LnpRecordKey(optional): integer(int64)
  The unique identifier for a record. The record can be for permits, business licenses, professional licenses, or planning and zoning, which is determined by the classification.
• PcsCommentId(optional): integer(int64)
  The unique identifier of the workflow comment.
• PcsCommentType: string
  Maximum Length: 5

  The source application corresponding to the comment. It holds a code corresponding to the application.
• TaskId(optional): string
  Maximum Length: 50

  The unique identifier of the workflow task.
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  The indicator that determines whether the comment should be hidden from public users or not.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the workflow comment."
        },
        "CommentPreview":{
            "type":"string",
            "description":"This field is used to show the preview of the entered comments. It is usually the first 100-200 characters of the comment, which is a configurable number.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The comment that has been entered by the user.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who has added the comment.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the comment was added.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the most recent update to the comment was made.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who has most recently updated the comment.",
            "title":"Last Updated By"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a record. The record can be for permits, business licenses, professional licenses, or planning and zoning, which is determined by the classification."
        },
        "PcsCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the workflow comment."
        },
        "PcsCommentType":{
            "maxLength":5,
            "type":"string",
            "description":"The source application corresponding to the comment. It holds a code corresponding to the application."
        },
        "TaskId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the workflow task."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The indicator that determines whether the comment should be hidden from public users or not.",
            "title":"Hide from Public"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "required":[
        "PcsCommentType"
    ],
    "discriminator":"PcsCommentType",
    "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 : publicSectorPcsComments-item

Type: object

Discriminator: PcsCommentType

Show Source

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

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

  This field is used to show the preview of the entered comments. It is usually the first 100-200 characters of the comment, which is a configurable number.
• CommentText(optional): string
  Title: Comments

  The comment that has been entered by the user.
• CreatedByName(optional): string
  Title: Created By

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

  The date on which the comment was added.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date on which the most recent update to the comment was made.
• LastUpdatedByName(optional): string
  Title: Last Updated By

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

  Link Relations
• LnpRecordKey(optional): integer(int64)
  The unique identifier for a record. The record can be for permits, business licenses, professional licenses, or planning and zoning, which is determined by the classification.
• PcsCommentId(optional): integer(int64)
  The unique identifier of the workflow comment.
• PcsCommentType: string
  Maximum Length: 5

  The source application corresponding to the comment. It holds a code corresponding to the application.
• TaskId(optional): string
  Maximum Length: 50

  The unique identifier of the workflow task.
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  The indicator that determines whether the comment should be hidden from public users or not.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the workflow comment."
        },
        "CommentPreview":{
            "type":"string",
            "description":"This field is used to show the preview of the entered comments. It is usually the first 100-200 characters of the comment, which is a configurable number.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The comment that has been entered by the user.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who has added the comment.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the comment was added.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the most recent update to the comment was made.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who has most recently updated the comment.",
            "title":"Last Updated By"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a record. The record can be for permits, business licenses, professional licenses, or planning and zoning, which is determined by the classification."
        },
        "PcsCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the workflow comment."
        },
        "PcsCommentType":{
            "maxLength":5,
            "type":"string",
            "description":"The source application corresponding to the comment. It holds a code corresponding to the application."
        },
        "TaskId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the workflow task."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The indicator that determines whether the comment should be hidden from public users or not.",
            "title":"Hide from Public"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "required":[
        "PcsCommentType"
    ],
    "discriminator":"PcsCommentType",
    "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