Jump to

• Request
• Response

Create a business category

post

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories

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

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The agency identifier of the public sector entity to which this business category applies.
• BusCategory(optional): string
  Maximum Length: 50

  The unique identifier for the business category.
• BusinessSubcategory(optional): array Business Subcategories
  Title: Business Subcategories

  Use the business categories resource to view, update, create, and delete business categories. A business category is used to specify the business category of a business entity.
• Category(optional): string
  Maximum Length: 25

  The value that will be displayed for business category.
• Description(optional): string
  Maximum Length: 100

  The long description value for business category.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the business category is enabled. The default value is Yes.
• 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 business category applies."
        },
        "BusCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business category."
        },
        "BusinessSubcategory":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessCategories-BusinessSubcategory-item"
            },
            "type":"array",
            "description":"Use the business categories resource to view, update, create, and delete business categories. A business category is used to specify the business category of a business entity.",
            "title":"Business Subcategories"
        },
        "Category":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for business category."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The long description value for business category."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business category is enabled. The default value is Yes."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Business Subcategories

Type: array

Title: Business Subcategories

Use the business categories resource to view, update, create, and delete business categories. A business category is used to specify the business category of a business entity.

Show Source

• Array of: object publicSectorBusinessCategories-BusinessSubcategory-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessCategories-BusinessSubcategory-item"
    },
    "type":"array",
    "description":"Use the business categories resource to view, update, create, and delete business categories. A business category is used to specify the business category of a business entity.",
    "title":"Business 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 : publicSectorBusinessCategories-BusinessSubcategory-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The agency identifier of the public sector entity to which this business subcategory applies.
• BusCategory(optional): string
  Maximum Length: 50

  The unique identifier for the business category.
• BusSubCategory(optional): string
  Maximum Length: 50

  The unique identifier for the business subcategory.
• Description(optional): string
  Maximum Length: 100

  The long description value for business subcategory.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the business subcategory is enabled. The default value is Yes.
• links(optional): array Items
  Title: Items

  Link Relations
• Subcategory(optional): string
  Maximum Length: 25

  The value that will be displayed for business subcategory.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this business subcategory applies."
        },
        "BusCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business category."
        },
        "BusSubCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business subcategory."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The long description value for business subcategory."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business subcategory is enabled. The default value is Yes."
        },
        "Subcategory":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for business 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 : publicSectorBusinessCategories-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The agency identifier of the public sector entity to which this business category applies.
• BusCategory(optional): string
  Maximum Length: 50

  The unique identifier for the business category.
• BusinessSubcategory(optional): array Business Subcategories
  Title: Business Subcategories

  Use the business categories resource to view, update, create, and delete business categories. A business category is used to specify the business category of a business entity.
• Category(optional): string
  Maximum Length: 25

  The value that will be displayed for business category.
• Description(optional): string
  Maximum Length: 100

  The long description value for business category.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the business category is enabled. The default value is Yes.
• 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 business category applies."
        },
        "BusCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business category."
        },
        "BusinessSubcategory":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessCategories-BusinessSubcategory-item"
            },
            "type":"array",
            "description":"Use the business categories resource to view, update, create, and delete business categories. A business category is used to specify the business category of a business entity.",
            "title":"Business Subcategories"
        },
        "Category":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for business category."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The long description value for business category."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business category is enabled. The default value is Yes."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Business Subcategories

Type: array

Title: Business Subcategories

Use the business categories resource to view, update, create, and delete business categories. A business category is used to specify the business category of a business entity.

Show Source

• Array of: object publicSectorBusinessCategories-BusinessSubcategory-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessCategories-BusinessSubcategory-item"
    },
    "type":"array",
    "description":"Use the business categories resource to view, update, create, and delete business categories. A business category is used to specify the business category of a business entity.",
    "title":"Business 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 : publicSectorBusinessCategories-BusinessSubcategory-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The agency identifier of the public sector entity to which this business subcategory applies.
• BusCategory(optional): string
  Maximum Length: 50

  The unique identifier for the business category.
• BusSubCategory(optional): string
  Maximum Length: 50

  The unique identifier for the business subcategory.
• Description(optional): string
  Maximum Length: 100

  The long description value for business subcategory.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the business subcategory is enabled. The default value is Yes.
• links(optional): array Items
  Title: Items

  Link Relations
• Subcategory(optional): string
  Maximum Length: 25

  The value that will be displayed for business subcategory.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this business subcategory applies."
        },
        "BusCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business category."
        },
        "BusSubCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business subcategory."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The long description value for business subcategory."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business subcategory is enabled. The default value is Yes."
        },
        "Subcategory":{
            "maxLength":25,
            "type":"string",
            "description":"The value that will be displayed for business 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