Jump to

• Request
• Response

Update a workflow comment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}

Request

Path Parameters

• publicSectorPcsCommentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PcsCommentId, TaskId and LnpRecordKey ---for the Workflow Comments resource and used to uniquely identify an instance of Workflow Comments. The client should not generate the hash key value. Instead, the client should query on the Workflow Comments collection resource with a filter on the primary key values in order to navigate to a specific instance of Workflow Comments.
  
  For example: publicSectorPcsComments?q=PcsCommentId=<value1>;TaskId=<value2>;LnpRecordKey=<value3>

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 that has been entered by the user.
• LnpRecordKey: 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.
• TaskId: string
  Maximum Length: 100

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

  Maximum Length: 1

  Default Value: Y

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

{
    "type":"object",
    "properties":{
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":"1",
            "type":"string",
            "description":"The indicator that determines whether the comment should be hidden from public users or not.",
            "nullable":false,
            "default":"Y"
        },
        "TaskId":{
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the workflow task.",
            "nullable":false
        },
        "LnpRecordKey":{
            "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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The comment that has been entered by the user.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Read Only: true

  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: string (byte)
  Title: Comments

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  The name of the user who has most recently updated the comment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordKey: 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.
• OriginalCreatedBy: string
  The name of the user who created the comment.
• PcsCommentId: integer (int64)
  The unique identifier of the workflow comment.
• PcsCommentType: string
  Maximum Length: 5

  Default Value: PCS

  The source application corresponding to the comment. It holds a code corresponding to the application.
• TaskId: string
  Maximum Length: 100

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

  Maximum Length: 1

  Default Value: Y

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

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the user who has added the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the comment was added.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "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.",
            "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
            }
        },
        "TaskId":{
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the workflow task.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The comment that has been entered by the user.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PcsCommentType":{
            "maxLength":"5",
            "type":"string",
            "description":"The source application corresponding to the comment. It holds a code corresponding to the application.",
            "nullable":false,
            "default":"PCS",
            "x-queryable":true
        },
        "LnpRecordKey":{
            "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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"The unique identifier of the workflow comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PcsCommentId":{
            "type":"integer",
            "description":"The unique identifier of the workflow comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 indicator that determines whether the comment should be hidden from public users or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who has most recently updated the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the most recent update to the comment was made.",
            "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