Jump to

• Request
• Response

Update a document group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}

Request

Path Parameters

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

• Description: string
  Title: Description

  Maximum Length: 500

  Indicates the value that will describe the document group.
• DocumentGroup: string
  Title: Group

  Maximum Length: 25

  Indicates the value that will be displayed for document group.
• DocumentGroupCategory: array Document Group Categories
  Title: Document Group Categories

  Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates if the document group is enabled or not for selection in attachments. If True the document group is enabled and valid document category values then can be selected. If false the document group will have any valid document category values that can be selected. Default value is false.

{
    "type":"object",
    "properties":{
        "DocumentGroup":{
            "title":"Group",
            "maxLength":"25",
            "type":"string",
            "description":"Indicates the value that will be displayed for document group.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"Indicates the value that will describe the document group.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the document group is enabled or not for selection in attachments.  If True the document group is enabled and valid document category values then can be selected. If false the document group will have any valid document category values that can be selected.  Default value is false.",
            "nullable":false
        },
        "DocumentGroupCategory":{
            "title":"Document Group Categories",
            "type":"array",
            "description":"Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDocumentGroups-DocumentGroupCategory-item-patch-request"
            }
        }
    }
}

Nested Schema : Document Group Categories

Type: array

Title: Document Group Categories

Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.

Show Source

• Array of: object publicSectorDocumentGroups-DocumentGroupCategory-item-patch-request

{
    "title":"Document Group Categories",
    "type":"array",
    "description":"Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDocumentGroups-DocumentGroupCategory-item-patch-request"
    }
}

Nested Schema : publicSectorDocumentGroups-DocumentGroupCategory-item-patch-request

Type: object

Show Source

• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

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

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the document group category is enabled or not for selection in attachments. If true, the document group category is enabled and is a valid value that can be selected as a document category for an attachment. If false, the document group category is not a valid value that can be selected as a document category for an attachment. The default value is false.",
            "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 : publicSectorDocumentGroups-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this document group applies.
• CreationDate: string (date-time)
  Read Only: true

  The timestamp on which the document group was created.
• Description: string
  Title: Description

  Maximum Length: 500

  Indicates the value that will describe the document group.
• DocumentGroup: string
  Title: Group

  Maximum Length: 25

  Indicates the value that will be displayed for document group.
• DocumentGroupCategory: array Document Group Categories
  Title: Document Group Categories

  Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.
• DocumentGroupId: string
  Title: Group ID

  Maximum Length: 30

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

  Maximum Length: 1

  Indicates if the document group is enabled or not for selection in attachments. If True the document group is enabled and valid document category values then can be selected. If false the document group will have any valid document category values that can be selected. Default value is false.
• LastUpdateDate: string (date-time)
  Read Only: true

  The timestamp on which the document group was last modified.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The timestamp on which the document group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentGroupId":{
            "title":"Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document group.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"Indicates the value that will describe the document group.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document group applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "DocumentGroup":{
            "title":"Group",
            "maxLength":"25",
            "type":"string",
            "description":"Indicates the value that will be displayed for document group.",
            "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 if the document group is enabled or not for selection in attachments.  If True the document group is enabled and valid document category values then can be selected. If false the document group will have any valid document category values that can be selected.  Default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentGroupCategory":{
            "title":"Document Group Categories",
            "type":"array",
            "description":"Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDocumentGroups-DocumentGroupCategory-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The timestamp on which the document group was last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Document Group Categories

Type: array

Title: Document Group Categories

Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.

Show Source

• Array of: object publicSectorDocumentGroups-DocumentGroupCategory-item-response

{
    "title":"Document Group Categories",
    "type":"array",
    "description":"Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDocumentGroups-DocumentGroupCategory-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 : publicSectorDocumentGroups-DocumentGroupCategory-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this document group category applies.
• CreationDate: string (date-time)
  Read Only: true

  The date when the document category group was created.
• DocumentCategory: string
  Title: Category ID

  Maximum Length: 30

  The unique identifier for the document category group.
• DocumentGroupId: string
  Title: Group ID

  Maximum Length: 30

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

  Maximum Length: 1

  Indicates whether the document group category is enabled or not for selection in attachments. If true, the document group category is enabled and is a valid value that can be selected as a document category for an attachment. If false, the document group category is not a valid value that can be selected as a document category for an attachment. The default value is false.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the document category group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentGroupId":{
            "title":"Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document group.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document group category applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "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 group category is enabled or not for selection in attachments. If true, the document group category is enabled and is a valid value that can be selected as a document category for an attachment. If false, the document group category is not a valid value that can be selected as a document category for an attachment. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentCategory":{
            "title":"Category ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document category group.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the document category group 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

DocumentGroupCategory

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory

Parameters:

• publicSectorDocumentGroupsUniqID: $request.path.publicSectorDocumentGroupsUniqID

Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.

Back to Top