Jump to

• Request
• Response

Update a comment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorIncidentComments/{CommentKey}

Request

Path Parameters

• CommentKey(required): integer(int64)
  The comment key.

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

• CommentText: string (byte)
  Title: Comments

  The text of the comment in HTML format.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  Indicates whether the comment is visible.

{
    "type":"object",
    "properties":{
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the comment is visible.",
            "nullable":false,
            "default":"Y"
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the comment in HTML format.",
            "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 : publicSectorIncidentComments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier for the agency.
• CommentId: integer (int64)
  This comment ID.
• CommentKey: integer (int64)
  The comment key.
• CommentPreview: string
  Title: Comment Preview

  Read Only: true

  The text of the comment in plain text format. This is used to preview the comment.
• CommentPuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated comment record.
• CommentText: string (byte)
  Title: Comments

  The text of the comment in HTML format.
• CreatedByName: string
  Title: Created By

  Read Only: true

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

  Read Only: true

  The date and time that the row was created.
• IncidentPuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated parent incident record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time that the row was last updated.
• LastUpdatedByName: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalCreatedBy: string
  The name of the user who created the comment.
• TransactionKey: integer (int64)
  The transaction key for the transaction that the comment is associated with.
• TransactionType: string
  Read Only: true

  Maximum Length: 10

  Default Value: INC

  The type of transaction that the comment is associated with.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  Indicates whether the comment is visible.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Created By",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":10,
            "type":"string",
            "description":"The type of transaction that the comment is associated with.",
            "nullable":false,
            "readOnly":true,
            "default":"INC",
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"The text of the comment in plain text format. This is used to preview the comment.",
            "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
            }
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The transaction key for the transaction that the comment is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the comment in HTML format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CommentKey":{
            "type":"integer",
            "description":"The comment key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"This comment ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated comment record.",
            "nullable":false,
            "default":" ",
            "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":"Indicates whether the comment is visible.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IncidentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated parent incident record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time that the row 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