Jump to

• Request
• Response

Update a document group category

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory/{DocumentGroupCategoryUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorDocumentGroups-DocumentGroupCategory-item

Type: object

Show Source

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

  The agency identifier of the public sector entity to which this document group category applies.
• CreationDate(optional): string(date-time)
  The date when the document category group was created.
• DocumentCategory(optional): string
  Title: Category ID

  Maximum Length: 30

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

  Maximum Length: 30

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

  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(optional): string(date-time)
  The date when the document category group was last modified.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document group category applies.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the document category group was created."
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category group.",
            "title":"Category ID"
        },
        "DocumentGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document group.",
            "title":"Group ID"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the document category group was last modified."
        },
        "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 : publicSectorDocumentGroups-DocumentGroupCategory-item

Type: object

Show Source

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

  The agency identifier of the public sector entity to which this document group category applies.
• CreationDate(optional): string(date-time)
  The date when the document category group was created.
• DocumentCategory(optional): string
  Title: Category ID

  Maximum Length: 30

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

  Maximum Length: 30

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

  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(optional): string(date-time)
  The date when the document category group was last modified.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document group category applies.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the document category group was created."
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category group.",
            "title":"Category ID"
        },
        "DocumentGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document group.",
            "title":"Group ID"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the document category group was last modified."
        },
        "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