Jump to

• Request
• Response

Create a document category

post

/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories

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

Type: object

Show Source

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

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

  Maximum Length: 25

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

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

  Maximum Length: 100

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

  Maximum Length: 30

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

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

  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(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the document category was last modified.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document category applies.",
            "title":"Agency ID"
        },
        "Category":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for the document category related to an attachment.",
            "title":"Category"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the document category was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The long description value for the document category related to an attachment.",
            "title":"Description"
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category.",
            "title":"Category ID"
        },
        "DocumentSubcategory":{
            "items":{
                "$ref":"#/definitions/publicSectorDocumentCategories-DocumentSubcategory-item"
            },
            "type":"array",
            "description":"Use the document categories resource to view, update, create, and delete document categories. A document category is used to specify a category for an uploaded attachment.",
            "title":"Document Subcategories"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the document category was last modified.",
            "title":"Last Updated Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Document Subcategories

Type: array

Title: Document Subcategories

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

Show Source

• Array of: object publicSectorDocumentCategories-DocumentSubcategory-item

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

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 : publicSectorDocumentCategories-DocumentSubcategory-item

Type: object

Show Source

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

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

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

  Maximum Length: 100

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

  Maximum Length: 30

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

  Maximum Length: 30

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

  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(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the document subcategory was last modified.
• links(optional): array Items
  Title: Items

  Link Relations
• Subcategory(optional): string
  Title: Subcategory

  Maximum Length: 25

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

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document subcategory applies.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the document subcategory was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The long description value for the document subcategory related to an attachment.",
            "title":"Description"
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category.",
            "title":"Category ID"
        },
        "DocumentSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document subcategory.",
            "title":"Subcategory ID"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the document subcategory was last modified.",
            "title":"Last Updated Date"
        },
        "Subcategory":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for the document subcategory related to an attachment.",
            "title":"Subcategory"
        },
        "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 : publicSectorDocumentCategories-item

Type: object

Show Source

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

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

  Maximum Length: 25

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

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

  Maximum Length: 100

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

  Maximum Length: 30

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

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

  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(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the document category was last modified.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document category applies.",
            "title":"Agency ID"
        },
        "Category":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for the document category related to an attachment.",
            "title":"Category"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the document category was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The long description value for the document category related to an attachment.",
            "title":"Description"
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category.",
            "title":"Category ID"
        },
        "DocumentSubcategory":{
            "items":{
                "$ref":"#/definitions/publicSectorDocumentCategories-DocumentSubcategory-item"
            },
            "type":"array",
            "description":"Use the document categories resource to view, update, create, and delete document categories. A document category is used to specify a category for an uploaded attachment.",
            "title":"Document Subcategories"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the document category was last modified.",
            "title":"Last Updated Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Document Subcategories

Type: array

Title: Document Subcategories

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

Show Source

• Array of: object publicSectorDocumentCategories-DocumentSubcategory-item

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

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 : publicSectorDocumentCategories-DocumentSubcategory-item

Type: object

Show Source

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

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

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

  Maximum Length: 100

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

  Maximum Length: 30

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

  Maximum Length: 30

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

  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(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the document subcategory was last modified.
• links(optional): array Items
  Title: Items

  Link Relations
• Subcategory(optional): string
  Title: Subcategory

  Maximum Length: 25

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

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document subcategory applies.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the document subcategory was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The long description value for the document subcategory related to an attachment.",
            "title":"Description"
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category.",
            "title":"Category ID"
        },
        "DocumentSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document subcategory.",
            "title":"Subcategory ID"
        },
        "EnabledFlag":{
            "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.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the document subcategory was last modified.",
            "title":"Last Updated Date"
        },
        "Subcategory":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for the document subcategory related to an attachment.",
            "title":"Subcategory"
        },
        "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