Jump to

• Request
• Response

Update a case comment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCaseComments/{CommentKey}

Request

Supported Media Types

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

Path Parameters

• CommentKey: integer
  The unique identifier of the case comment.

Body ()

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

Root Schema : publicSectorCaseComments-item

Type: object

Show Source

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

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

  The preview of the case comment.
• CommentText(optional): string
  Title: Comments

  The text content of the case comment.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Link Relations
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  The visibility of the case comment.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case comment.",
            "title":"Agency ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case comment."
        },
        "CommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case comment."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The preview of the case comment.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The text content of the case comment.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The visibility of the case comment.",
            "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 : publicSectorCaseComments-item

Type: object

Show Source

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

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

  The preview of the case comment.
• CommentText(optional): string
  Title: Comments

  The text content of the case comment.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Link Relations
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  The visibility of the case comment.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case comment.",
            "title":"Agency ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case comment."
        },
        "CommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case comment."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The preview of the case comment.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The text content of the case comment.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The visibility of the case comment.",
            "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