Jump to

• Request
• Response

Create a document group

post

/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorDocumentGroups-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 applies.
• CreationDate(optional): string(date-time)
  The timestamp on which the document group was created.
• Description(optional): string
  Title: Description

  Maximum Length: 500

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

  Maximum Length: 25

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

  Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.
• DocumentGroupId(optional): string
  Title: Group ID

  Maximum Length: 30

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

  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(optional): string(date-time)
  The timestamp on which the document 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 applies.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The timestamp on which the document group was created."
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"Indicates the value that will describe the document group.",
            "title":"Description"
        },
        "DocumentGroup":{
            "maxLength":25,
            "type":"string",
            "description":"Indicates the value that will be displayed for document group.",
            "title":"Group"
        },
        "DocumentGroupCategory":{
            "items":{
                "$ref":"#/definitions/publicSectorDocumentGroups-DocumentGroupCategory-item"
            },
            "type":"array",
            "description":"Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.",
            "title":"Document Group Categories"
        },
        "DocumentGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document group.",
            "title":"Group ID"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The timestamp on which the document group was last modified."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Document Group Categories

Type: array

Title: Document Group Categories

Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.

Show Source

• Array of: object publicSectorDocumentGroups-DocumentGroupCategory-item

{
    "items":{
        "$ref":"#/definitions/publicSectorDocumentGroups-DocumentGroupCategory-item"
    },
    "type":"array",
    "description":"Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.",
    "title":"Document Group Categories"
}

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 : 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-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 applies.
• CreationDate(optional): string(date-time)
  The timestamp on which the document group was created.
• Description(optional): string
  Title: Description

  Maximum Length: 500

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

  Maximum Length: 25

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

  Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.
• DocumentGroupId(optional): string
  Title: Group ID

  Maximum Length: 30

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

  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(optional): string(date-time)
  The timestamp on which the document 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 applies.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The timestamp on which the document group was created."
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"Indicates the value that will describe the document group.",
            "title":"Description"
        },
        "DocumentGroup":{
            "maxLength":25,
            "type":"string",
            "description":"Indicates the value that will be displayed for document group.",
            "title":"Group"
        },
        "DocumentGroupCategory":{
            "items":{
                "$ref":"#/definitions/publicSectorDocumentGroups-DocumentGroupCategory-item"
            },
            "type":"array",
            "description":"Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.",
            "title":"Document Group Categories"
        },
        "DocumentGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document group.",
            "title":"Group ID"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The timestamp on which the document group was last modified."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Document Group Categories

Type: array

Title: Document Group Categories

Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.

Show Source

• Array of: object publicSectorDocumentGroups-DocumentGroupCategory-item

{
    "items":{
        "$ref":"#/definitions/publicSectorDocumentGroups-DocumentGroupCategory-item"
    },
    "type":"array",
    "description":"Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.",
    "title":"Document Group Categories"
}

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 : 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