Jump to

• Request
• Response

Update a business category

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}

Request

Path Parameters

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

• BusinessSubcategory: array Business Subcategories
  Title: Business Subcategories

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

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

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

  Indicates whether the business category is enabled. The default value is Yes.

{
    "type":"object",
    "properties":{
        "Category":{
            "maxLength":"25",
            "type":"string",
            "description":"The value that will be displayed for business category.",
            "nullable":false
        },
        "Description":{
            "maxLength":"100",
            "type":"string",
            "description":"The long description value for business category.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the business category is enabled. The default value is Yes.",
            "nullable":false
        },
        "BusinessSubcategory":{
            "title":"Business Subcategories",
            "type":"array",
            "description":"Use the business subcategories resource to view, update, create, and delete business subcategories. A business subcategory is used to specify the subcategory of a business category of a business entity.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessCategories-BusinessSubcategory-item-patch-request"
            }
        }
    }
}

Nested Schema : Business Subcategories

Type: array

Title: Business Subcategories

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

Show Source

• Array of: object schema

{
    "title":"Business Subcategories",
    "type":"array",
    "description":"Use the business subcategories resource to view, update, create, and delete business subcategories. A business subcategory is used to specify the subcategory of a business category of a business entity.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBusinessCategories-BusinessSubcategory-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Description: string
  Maximum Length: 100

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

  Indicates whether the business subcategory is enabled. The default value is Yes.
• Subcategory: string
  Maximum Length: 25

  The value that will be displayed for business subcategory.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"100",
            "type":"string",
            "description":"The long description value for business subcategory.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the business subcategory is enabled. The default value is Yes.",
            "nullable":true
        },
        "Subcategory":{
            "maxLength":"25",
            "type":"string",
            "description":"The value that will be displayed for business subcategory.",
            "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 : publicSectorBusinessCategories-item-response

Type: object

Show Source

• AgencyId: integer
  Default Value: 1

  The agency identifier of the public sector entity to which this business category applies.
• BusCategory: string
  Maximum Length: 50

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

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

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

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

  Indicates whether the business category is enabled. The default value is Yes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "Category":{
            "maxLength":"25",
            "type":"string",
            "description":"The value that will be displayed for business category.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"100",
            "type":"string",
            "description":"The long description value for business category.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this business category applies.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "BusinessSubcategory":{
            "title":"Business Subcategories",
            "type":"array",
            "description":"Use the business subcategories resource to view, update, create, and delete business subcategories. A business subcategory is used to specify the subcategory of a business category of a business entity.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessCategories-BusinessSubcategory-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the business category is enabled. The default value is Yes.",
            "nullable":false,
            "x-queryable":true
        },
        "BusCategory":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the business category.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Business Subcategories

Type: array

Title: Business Subcategories

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

Show Source

• Array of: object publicSectorBusinessCategories-BusinessSubcategory-item-response

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

Type: object

Show Source

• AgencyId: integer
  Default Value: 1

  The agency identifier of the public sector entity to which this business subcategory applies.
• BusCategory: string
  Maximum Length: 50

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

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

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

  Indicates whether the business subcategory is enabled. The default value is Yes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Subcategory: string
  Maximum Length: 25

  The value that will be displayed for business subcategory.

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

BusinessSubcategory

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorBusinessCategories/{publicSectorBusinessCategoriesUniqID}/child/BusinessSubcategory

Parameters:

• publicSectorBusinessCategoriesUniqID: $request.path.publicSectorBusinessCategoriesUniqID

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

Back to Top