Jump to

• Request
• Response

Update a favorite comment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorFavoriteComments/{publicSectorFavoriteCommentsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorFavoriteCommentsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- UserName, AgencyId and StandardCommentId ---for the Favorite Comments resource and used to uniquely identify an instance of Favorite Comments. The client should not generate the hash key value. Instead, the client should query on the Favorite Comments collection resource with a filter on the primary key values in order to navigate to a specific instance of Favorite Comments.
  
  For example: publicSectorFavoriteComments?q=UserName=<value1>;AgencyId=<value2>;StandardCommentId=<value3>

Body ()

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

Root Schema : publicSectorFavoriteComments-item

Type: object

Show Source

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

  The agency ID of the record.
• CommentPreview(optional): string
  Title: Comment Preview

  The preview text of the standard comment.
• Comments(optional): string
  Title: Comments

  The text of the standard 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
• StandardCommentId(optional): string
  Title: Comment Code

  Maximum Length: 200

  The standard comment ID of the record.
• UserName(optional): string
  Maximum Length: 100

  The name of the user who created the row.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID of the record.",
            "title":"Agency ID"
        },
        "CommentPreview":{
            "type":"string",
            "description":"The preview text of the standard comment.",
            "title":"Comment Preview"
        },
        "Comments":{
            "type":"string",
            "description":"The text of the standard 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"
        },
        "StandardCommentId":{
            "maxLength":200,
            "type":"string",
            "description":"The standard comment ID of the record.",
            "title":"Comment Code"
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "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 : publicSectorFavoriteComments-item

Type: object

Show Source

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

  The agency ID of the record.
• CommentPreview(optional): string
  Title: Comment Preview

  The preview text of the standard comment.
• Comments(optional): string
  Title: Comments

  The text of the standard 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
• StandardCommentId(optional): string
  Title: Comment Code

  Maximum Length: 200

  The standard comment ID of the record.
• UserName(optional): string
  Maximum Length: 100

  The name of the user who created the row.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID of the record.",
            "title":"Agency ID"
        },
        "CommentPreview":{
            "type":"string",
            "description":"The preview text of the standard comment.",
            "title":"Comment Preview"
        },
        "Comments":{
            "type":"string",
            "description":"The text of the standard 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"
        },
        "StandardCommentId":{
            "maxLength":200,
            "type":"string",
            "description":"The standard comment ID of the record.",
            "title":"Comment Code"
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "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