Jump to

• Request
• Response

Update a checklist subcategory

patch

/fscmRestApi/resources/11.13.18.05/publicSectorChecklistSubcategories/{publicSectorChecklistSubcategoriesUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorChecklistSubcategoriesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId, CategoryCode and SubcategoryCode ---for the Inspection Checklist Subcategories resource and used to uniquely identify an instance of Inspection Checklist Subcategories. The client should not generate the hash key value. Instead, the client should query on the Inspection Checklist Subcategories collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Checklist Subcategories.
  
  For example: publicSectorChecklistSubcategories?q=AgencyId=<value1>;CategoryCode=<value2>;SubcategoryCode=<value3>

Body ()

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

Root Schema : publicSectorChecklistSubcategories-item

Type: object

Show Source

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

  The identifier for the public sector agency to which this checklist subcategory applies.
• CategoryCode(optional): string
  Title: Category

  Maximum Length: 30

  The unique code for the inspection checklist category.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the checklist subcategory.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

  Maximum Length: 100

  The description of the checklist subcategory.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the checklist subcategory was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the checklist subcategory.
• links(optional): array Items
  Title: Items

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

  Maximum Length: 30

  The unique code for the subcategory of an inspection checklist category.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this checklist subcategory applies.",
            "title":"Agency ID"
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the inspection checklist category.",
            "title":"Category"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the checklist subcategory.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist subcategory was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the checklist subcategory.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist subcategory was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the checklist subcategory.",
            "title":"Last Updated By"
        },
        "SubcategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the subcategory of an inspection checklist category.",
            "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 : publicSectorChecklistSubcategories-item

Type: object

Show Source

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

  The identifier for the public sector agency to which this checklist subcategory applies.
• CategoryCode(optional): string
  Title: Category

  Maximum Length: 30

  The unique code for the inspection checklist category.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the checklist subcategory.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

  Maximum Length: 100

  The description of the checklist subcategory.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the checklist subcategory was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the checklist subcategory.
• links(optional): array Items
  Title: Items

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

  Maximum Length: 30

  The unique code for the subcategory of an inspection checklist category.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this checklist subcategory applies.",
            "title":"Agency ID"
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the inspection checklist category.",
            "title":"Category"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the checklist subcategory.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist subcategory was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the checklist subcategory.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the checklist subcategory was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the checklist subcategory.",
            "title":"Last Updated By"
        },
        "SubcategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the subcategory of an inspection checklist category.",
            "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