Jump to

• Request
• Response

Update a document category

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}

Request

Path Parameters

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

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

Root Schema : schema

Type: object

Show Source

• Category: string
  Title: Category

  Maximum Length: 25

  The value that will be displayed for the document category related to an attachment.
• Description: string
  Title: Description

  Maximum Length: 100

  The long description value for the document category related to an attachment.
• DocumentSubcategory: array Document Subcategories
  Title: Document Subcategories

  Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the document category is enabled or not available for selection in attachments. If true, the document category is enabled and is a valid value that can be selected as a document category. If false, the document category is not a valid value and can't be selected as a document category. The default value is true.

{
    "type":"object",
    "properties":{
        "DocumentSubcategory":{
            "title":"Document Subcategories",
            "type":"array",
            "description":"Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDocumentCategories-DocumentSubcategory-item-patch-request"
            }
        },
        "Category":{
            "title":"Category",
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for the document category related to an attachment.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The long description value for the document category related to an attachment.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the document category is enabled or not available for selection in attachments. If true, the document category is enabled and is a valid value that can be selected as a document category. If false, the document category is not a valid value and can't be selected as a document category. The default value is true.",
            "nullable":false
        }
    }
}

Nested Schema : Document Subcategories

Type: array

Title: Document Subcategories

Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.

Show Source

• Array of: object publicSectorDocumentCategories-DocumentSubcategory-item-patch-request

{
    "title":"Document Subcategories",
    "type":"array",
    "description":"Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDocumentCategories-DocumentSubcategory-item-patch-request"
    }
}

Nested Schema : publicSectorDocumentCategories-DocumentSubcategory-item-patch-request

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 100

  The long description value for the document subcategory related to an attachment.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true.
• Subcategory: string
  Title: Subcategory

  Maximum Length: 25

  The value that will be displayed for the document subcategory related to an attachment.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The long description value for the document subcategory related to an attachment.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true.",
            "nullable":false
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for the document subcategory related to an attachment.",
            "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(required):
  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(required):
  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 : publicSectorDocumentCategories-item-response

Type: object

Show Source

• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this document category applies.
• Category: string
  Title: Category

  Maximum Length: 25

  The value that will be displayed for the document category related to an attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 100

  The long description value for the document category related to an attachment.
• DocumentCategory: string
  Title: Category ID

  Maximum Length: 30

  The unique identifier for the document category.
• DocumentSubcategory: array Document Subcategories
  Title: Document Subcategories

  Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the document category is enabled or not available for selection in attachments. If true, the document category is enabled and is a valid value that can be selected as a document category. If false, the document category is not a valid value and can't be selected as a document category. The default value is true.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the document category was last modified.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the document category was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentSubcategory":{
            "title":"Document Subcategories",
            "type":"array",
            "description":"Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDocumentCategories-DocumentSubcategory-item-response"
            }
        },
        "Category":{
            "title":"Category",
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for the document category related to an attachment.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The long description value for the document category related to an attachment.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document category applies.",
            "nullable":false,
            "default":1,
            "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 whether the document category is enabled or not available for selection in attachments. If true, the document category is enabled and is a valid value that can be selected as a document category. If false, the document category is not a valid value and can't be selected as a document category. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentCategory":{
            "title":"Category ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the document category was last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Document Subcategories

Type: array

Title: Document Subcategories

Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.

Show Source

• Array of: object publicSectorDocumentCategories-DocumentSubcategory-item-response

{
    "title":"Document Subcategories",
    "type":"array",
    "description":"Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDocumentCategories-DocumentSubcategory-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 : publicSectorDocumentCategories-DocumentSubcategory-item-response

Type: object

Show Source

• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this document subcategory applies.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 100

  The long description value for the document subcategory related to an attachment.
• DocumentCategory: string
  Title: Category ID

  Maximum Length: 30

  The unique identifier for the document category.
• DocumentSubcategory: string
  Title: Subcategory ID

  Maximum Length: 30

  The unique identifier for the document subcategory.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the document subcategory was last modified.
• links: array Links
  Title: Links

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

  Maximum Length: 25

  The value that will be displayed for the document subcategory related to an attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the document subcategory was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentSubcategory":{
            "title":"Subcategory ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document subcategory.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The long description value for the document subcategory related to an attachment.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document subcategory applies.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for the document subcategory related to an attachment.",
            "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 whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentCategory":{
            "title":"Category ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the document subcategory was last modified.",
            "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."
        }
    }
}

Links

DocumentSubcategory

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory

Parameters:

• publicSectorDocumentCategoriesUniqID: $request.path.publicSectorDocumentCategoriesUniqID

Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.

Back to Top