Jump to

• Request
• Response

Update a comment category

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}

Request

Path Parameters

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

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CommentApplicationGroups: array Comment Application Groups
  Title: Comment Application Groups

  The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.
• CommentSubCategories: array Comment Subcategories
  Title: Comment Subcategories

  The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.
• Description: string
  Title: Description

  Maximum Length: 300

  The name of the comment category.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates that the comment category is available to be used. The comment category is disabled by default.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the comment category.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the comment category is available to be used. The comment category is disabled by default.",
            "nullable":false
        },
        "CommentSubCategories":{
            "title":"Comment Subcategories",
            "type":"array",
            "description":"The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCommentCategories-CommentSubCategories-item-patch-request"
            }
        },
        "CommentApplicationGroups":{
            "title":"Comment Application Groups",
            "type":"array",
            "description":"The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCommentCategories-CommentApplicationGroups-item-patch-request"
            }
        }
    }
}

Nested Schema : Comment Application Groups

Type: array

Title: Comment Application Groups

The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.

Show Source

• Array of: object publicSectorCommentCategories-CommentApplicationGroups-item-patch-request

{
    "title":"Comment Application Groups",
    "type":"array",
    "description":"The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCommentCategories-CommentApplicationGroups-item-patch-request"
    }
}

Nested Schema : Comment Subcategories

Type: array

Title: Comment Subcategories

The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.

Show Source

• Array of: object publicSectorCommentCategories-CommentSubCategories-item-patch-request

{
    "title":"Comment Subcategories",
    "type":"array",
    "description":"The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCommentCategories-CommentSubCategories-item-patch-request"
    }
}

Nested Schema : publicSectorCommentCategories-CommentApplicationGroups-item-patch-request

Type: object

Show Source

• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates that the comment application group is available to be used. The default value for the comment application group is set as Disabled.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the comment application group is available to be used. The default value for the comment application group is set as Disabled.",
            "nullable":false
        }
    }
}

Nested Schema : publicSectorCommentCategories-CommentSubCategories-item-patch-request

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 300

  The name of the comment subcategory.
• EnabledFlag: boolean
  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.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the comment subcategory is available to be used. The default value for the comment subcategory is set as Disabled.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the comment subcategory.",
            "nullable":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 : publicSectorCommentCategories-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 30

  The comment category ID of the record.
• CommentApplicationGroups: array Comment Application Groups
  Title: Comment Application Groups

  The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.
• CommentSubCategories: array Comment Subcategories
  Title: Comment Subcategories

  The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the row was created.
• Description: string
  Title: Description

  Maximum Length: 300

  The name of the comment category.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates that the comment category is available to be used. The comment category is disabled by default.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the comment category.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID of the record.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "CategoryCd":{
            "title":"Comment Category",
            "maxLength":"30",
            "type":"string",
            "description":"The comment category ID of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the comment category is available to be used. The comment category is disabled by default.",
            "nullable":false,
            "x-queryable":true
        },
        "CommentSubCategories":{
            "title":"Comment Subcategories",
            "type":"array",
            "description":"The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCommentCategories-CommentSubCategories-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentApplicationGroups":{
            "title":"Comment Application Groups",
            "type":"array",
            "description":"The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCommentCategories-CommentApplicationGroups-item-response"
            }
        }
    }
}

Nested Schema : Comment Application Groups

Type: array

Title: Comment Application Groups

The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.

Show Source

• Array of: object publicSectorCommentCategories-CommentApplicationGroups-item-response

{
    "title":"Comment Application Groups",
    "type":"array",
    "description":"The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCommentCategories-CommentApplicationGroups-item-response"
    }
}

Nested Schema : Comment Subcategories

Type: array

Title: Comment Subcategories

The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.

Show Source

• Array of: object publicSectorCommentCategories-CommentSubCategories-item-response

{
    "title":"Comment Subcategories",
    "type":"array",
    "description":"The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCommentCategories-CommentSubCategories-item-response"
    }
}

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 : publicSectorCommentCategories-CommentApplicationGroups-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency ID of the record.
• ApplgroupCd: string
  Title: Application Group

  Maximum Length: 30

  The application group ID of the record.
• CategoryCd: string
  Title: Comment Category

  Maximum Length: 30

  The comment category ID of the record.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the row was created.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates that the comment application group is available to be used. The default value for the comment application group is set as Disabled.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID of the record.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "CategoryCd":{
            "title":"Comment Category",
            "maxLength":"30",
            "type":"string",
            "description":"The comment category ID of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ApplgroupCd":{
            "title":"Application Group",
            "maxLength":"30",
            "type":"string",
            "description":"The application group ID of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the comment application group is available to be used. The default value for the comment application group is set as Disabled.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when 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."
        }
    }
}

Nested Schema : publicSectorCommentCategories-CommentSubCategories-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 30

  The comment category ID of the record.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the row was created.
• Description: string
  Title: Description

  Maximum Length: 300

  The name of the comment subcategory.
• EnabledFlag: boolean
  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: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• SubcategoryCd: string
  Title: Comment Subcategory

  Maximum Length: 30

  The comment subcategory ID of the record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubcategoryCd":{
            "title":"Comment Subcategory",
            "maxLength":"30",
            "type":"string",
            "description":"The comment subcategory ID of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the comment subcategory.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency ID of the record.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "CategoryCd":{
            "title":"Comment Category",
            "maxLength":"30",
            "type":"string",
            "description":"The comment category ID of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the comment subcategory is available to be used. The default value for the comment subcategory is set as Disabled.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when 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"
    }
}

Links

CommentApplicationGroups

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentApplicationGroups

Parameters:

• publicSectorCommentCategoriesUniqID: $request.path.publicSectorCommentCategoriesUniqID

The comment application group resource is used to view, create, or modify a comment application group. You associate an application group to a comment category.

CommentSubCategories

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCommentCategories/{publicSectorCommentCategoriesUniqID}/child/CommentSubCategories

Parameters:

• publicSectorCommentCategoriesUniqID: $request.path.publicSectorCommentCategoriesUniqID

The comment subcategory resource is used to view, create, or modify a comment subcategory. You associate a comment subcategory to a comment category.

Back to Top