Jump to

• Request
• Response

Update an inspection checklist group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorChecklistGroups/{publicSectorChecklistGroupsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorChecklistGroups-item

Type: object

Show Source

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

  The identifier for the public sector agency to which this inspection checklist group applies.
• ChecklistGroup(optional): string
  Title: Checklist Group

  Maximum Length: 15

  The name that uniquely identifies an inspection checklist group.
• ChecklistGroupLine(optional): array Inspection Checklist Group Lines
  Title: Inspection Checklist Group Lines

  The inspection checklist group resource is used to view, create, delete or modify an inspection checklist group. An inspection checklist group identifies a set of checklists that can be associated to an inspection type. The group contains one or more checklist lines.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created this inspection checklist group.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

  Maximum Length: 100

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

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

  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this inspection checklist group applies.",
            "title":"Agency ID"
        },
        "ChecklistGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist group.",
            "title":"Checklist Group"
        },
        "ChecklistGroupLine":{
            "items":{
                "$ref":"#/definitions/publicSectorChecklistGroups-ChecklistGroupLine-item"
            },
            "type":"array",
            "description":"The inspection checklist group resource is used to view, create, delete or modify an inspection checklist group. An inspection checklist group identifies a set of checklists that can be associated to an inspection type. The group contains one or more checklist lines.",
            "title":"Inspection Checklist Group Lines"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created this inspection checklist group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection checklist group was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the inspection checklist group.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection checklist group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inspection checklist group.",
            "title":"Last Updated By"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Inspection Checklist Group Lines

Type: array

Title: Inspection Checklist Group Lines

The inspection checklist group resource is used to view, create, delete or modify an inspection checklist group. An inspection checklist group identifies a set of checklists that can be associated to an inspection type. The group contains one or more checklist lines.

Show Source

• Array of: object publicSectorChecklistGroups-ChecklistGroupLine-item

{
    "items":{
        "$ref":"#/definitions/publicSectorChecklistGroups-ChecklistGroupLine-item"
    },
    "type":"array",
    "description":"The inspection checklist group resource is used to view, create, delete or modify an inspection checklist group. An inspection checklist group identifies a set of checklists that can be associated to an inspection type. The group contains one or more checklist lines.",
    "title":"Inspection Checklist Group Lines"
}

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 : publicSectorChecklistGroups-ChecklistGroupLine-item

Type: object

Show Source

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

  The identifier for the public sector agency to which this checklist group line applies.
• ChecklistGroup(optional): string
  Title: Checklist Group

  Maximum Length: 15

  The name that uniquely identifies an inspection checklist group.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

  The name that uniquely identifies an inspection checklist.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who added the checklist group line to the checklist group.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date that the checklist group line was added to the checklist group.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the checklist group line was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this checklist group line applies.",
            "title":"Agency ID"
        },
        "ChecklistGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist group.",
            "title":"Checklist Group"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist.",
            "title":"Checklist"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who added the checklist group line to the checklist group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the checklist group line was added to the checklist group.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the checklist group line was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the checklist group line.",
            "title":"Last Updated By"
        },
        "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 : publicSectorChecklistGroups-item

Type: object

Show Source

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

  The identifier for the public sector agency to which this inspection checklist group applies.
• ChecklistGroup(optional): string
  Title: Checklist Group

  Maximum Length: 15

  The name that uniquely identifies an inspection checklist group.
• ChecklistGroupLine(optional): array Inspection Checklist Group Lines
  Title: Inspection Checklist Group Lines

  The inspection checklist group resource is used to view, create, delete or modify an inspection checklist group. An inspection checklist group identifies a set of checklists that can be associated to an inspection type. The group contains one or more checklist lines.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created this inspection checklist group.
• CreationDate(optional): string(date-time)
  Title: Creation Date

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

  Maximum Length: 100

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

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

  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this inspection checklist group applies.",
            "title":"Agency ID"
        },
        "ChecklistGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist group.",
            "title":"Checklist Group"
        },
        "ChecklistGroupLine":{
            "items":{
                "$ref":"#/definitions/publicSectorChecklistGroups-ChecklistGroupLine-item"
            },
            "type":"array",
            "description":"The inspection checklist group resource is used to view, create, delete or modify an inspection checklist group. An inspection checklist group identifies a set of checklists that can be associated to an inspection type. The group contains one or more checklist lines.",
            "title":"Inspection Checklist Group Lines"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created this inspection checklist group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection checklist group was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the inspection checklist group.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection checklist group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inspection checklist group.",
            "title":"Last Updated By"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Inspection Checklist Group Lines

Type: array

Title: Inspection Checklist Group Lines

The inspection checklist group resource is used to view, create, delete or modify an inspection checklist group. An inspection checklist group identifies a set of checklists that can be associated to an inspection type. The group contains one or more checklist lines.

Show Source

• Array of: object publicSectorChecklistGroups-ChecklistGroupLine-item

{
    "items":{
        "$ref":"#/definitions/publicSectorChecklistGroups-ChecklistGroupLine-item"
    },
    "type":"array",
    "description":"The inspection checklist group resource is used to view, create, delete or modify an inspection checklist group. An inspection checklist group identifies a set of checklists that can be associated to an inspection type. The group contains one or more checklist lines.",
    "title":"Inspection Checklist Group Lines"
}

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 : publicSectorChecklistGroups-ChecklistGroupLine-item

Type: object

Show Source

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

  The identifier for the public sector agency to which this checklist group line applies.
• ChecklistGroup(optional): string
  Title: Checklist Group

  Maximum Length: 15

  The name that uniquely identifies an inspection checklist group.
• ChecklistId(optional): string
  Title: Checklist

  Maximum Length: 15

  The name that uniquely identifies an inspection checklist.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who added the checklist group line to the checklist group.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date that the checklist group line was added to the checklist group.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the checklist group line was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this checklist group line applies.",
            "title":"Agency ID"
        },
        "ChecklistGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist group.",
            "title":"Checklist Group"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist.",
            "title":"Checklist"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who added the checklist group line to the checklist group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the checklist group line was added to the checklist group.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the checklist group line was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the checklist group line.",
            "title":"Last Updated By"
        },
        "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