Jump to

• Request
• Response

Update a comment for the conditions of approval

patch

/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments/{CommentKey}

Request

Path Parameters

• CommentKey(required): integer(int64)
  The unique identifier of the comment.

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

• CoaPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated condition of approval.
• CommentPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated comment.
• CommentText: string (byte)
  Title: Comments

  The actual text of the comment.
• MigratedDataFlag: string
  Maximum Length: 3

  Indicates whether the transaction was created online or migrated from a legacy system.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  Indicates if the comment is visible to the anonymous user.

{
    "type":"object",
    "properties":{
        "CoaPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated condition of approval.",
            "nullable":true
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated comment.",
            "nullable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The actual text of the comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the transaction was created online or migrated from a legacy system.",
            "nullable":true
        },
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the comment is visible to the anonymous user.",
            "nullable":false,
            "default":"Y"
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency.
• COACommentId: integer (int64)
  The unique identifier of the comment.
• CoaKey: integer (int64)
  The unique identifier of the conditions of approval.
• CoaPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated condition of approval.
• CommentId: integer (int64)
  The unique identifier of the comment.
• CommentKey: integer (int64)
  The unique identifier of the comment.
• CommentPreview: string
  Title: Comment Preview

  Read Only: true

  The preview of the comment text.
• CommentPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated comment.
• CommentText: string (byte)
  Title: Comments

  The actual text of the comment.
• CreatedByName: string
  Title: Created By

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  The date on which the comment was updated.
• LastUpdatedByName: string
  Title: Last Updated By

  Read Only: true

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

  The link relations associated with the resource instance.
• MigratedDataFlag: string
  Maximum Length: 3

  Indicates whether the transaction was created online or migrated from a legacy system.
• OriginalCreatedBy: string
  The name of the user who created the comment.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  Indicates if the comment is visible to the anonymous user.

{
    "type":"object",
    "properties":{
        "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
        },
        "COACommentId":{
            "type":"integer",
            "description":"The unique identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoaKey":{
            "type":"integer",
            "description":"The unique identifier of the conditions of approval.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoaPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated condition of approval.",
            "nullable":true,
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"The unique identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentKey":{
            "type":"integer",
            "description":"The unique identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"The preview of the comment text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated comment.",
            "nullable":true,
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The actual text of the comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedByName":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the person who created the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the comment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the comment was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the person who updated the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the transaction was created online or migrated from a legacy system.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the comment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the comment is visible to the anonymous user.",
            "nullable":false,
            "default":"Y",
            "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