Jump to

• Request
• Response

Update a comment subcategory

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCommentSubCategories/{publicSectorCommentSubCategoriesUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorCommentSubCategories-item

Type: object

Show Source

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

  The agency ID of the record.
• CategoryCd(optional): string
  Title: Comment Category

  Maximum Length: 30

  The comment category ID of the record.
• 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.
• Description(optional): string
  Title: Description

  Maximum Length: 300

  The name of the comment subcategory.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates that the comment subcategory is available to be used. The default value for the comment subcategory is set as Disabled.
• 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
• SubcategoryCd(optional): string
  Title: Comment Subcategory

  Maximum Length: 30

  The comment subcategory ID of the record.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID of the record.",
            "title":"Agency ID"
        },
        "CategoryCd":{
            "maxLength":30,
            "type":"string",
            "description":"The comment category ID of the record.",
            "title":"Comment Category"
        },
        "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"
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"The name of the comment subcategory.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the comment subcategory is available to be used. The default value for the comment subcategory is set as Disabled.",
            "title":"Enabled"
        },
        "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"
        },
        "SubcategoryCd":{
            "maxLength":30,
            "type":"string",
            "description":"The comment subcategory ID of the record.",
            "title":"Comment Subcategory"
        },
        "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 : publicSectorCommentSubCategories-item

Type: object

Show Source

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

  The agency ID of the record.
• CategoryCd(optional): string
  Title: Comment Category

  Maximum Length: 30

  The comment category ID of the record.
• 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.
• Description(optional): string
  Title: Description

  Maximum Length: 300

  The name of the comment subcategory.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates that the comment subcategory is available to be used. The default value for the comment subcategory is set as Disabled.
• 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
• SubcategoryCd(optional): string
  Title: Comment Subcategory

  Maximum Length: 30

  The comment subcategory ID of the record.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID of the record.",
            "title":"Agency ID"
        },
        "CategoryCd":{
            "maxLength":30,
            "type":"string",
            "description":"The comment category ID of the record.",
            "title":"Comment Category"
        },
        "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"
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"The name of the comment subcategory.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the comment subcategory is available to be used. The default value for the comment subcategory is set as Disabled.",
            "title":"Enabled"
        },
        "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"
        },
        "SubcategoryCd":{
            "maxLength":30,
            "type":"string",
            "description":"The comment subcategory ID of the record.",
            "title":"Comment Subcategory"
        },
        "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