Jump to

• Request
• Response

Update an inspection group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorInspectionGroups-item

Type: object

Show Source

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

  The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  Maximum Length: 100

  The description for a group of inspections that are associated with a permit type.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether an inspection group is available to be applied to a permit, license, or code enforcement record type. The default value is false.
• InspectionGroup(optional): string
  Title: Inspection Group

  Maximum Length: 15

  The identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.
• InspectionGroupLine(optional): array Inspection Group Lines
  Title: Inspection Group Lines

  The inspection group resource is used to view, create, delete, or modify an inspection group. An inspection group identifies the group of inspection types associated with a permit, license, or plan. The group contains one or more inspection lines.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inspection group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection group was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description for a group of inspections that are associated with a permit type.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether an inspection group is available to be applied to a permit, license, or code enforcement record type. The default value is false.",
            "title":"Enabled"
        },
        "InspectionGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.",
            "title":"Inspection Group"
        },
        "InspectionGroupLine":{
            "items":{
                "$ref":"#/definitions/publicSectorInspectionGroups-InspectionGroupLine-item"
            },
            "type":"array",
            "description":"The inspection group resource is used to view, create, delete, or modify an inspection group. An inspection group identifies the group of inspection types associated with a permit, license, or plan. The group contains one or more inspection lines.",
            "title":"Inspection Group Lines"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inspection group.",
            "title":"Last Updated By"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Inspection Group Lines

Type: array

Title: Inspection Group Lines

The inspection group resource is used to view, create, delete, or modify an inspection group. An inspection group identifies the group of inspection types associated with a permit, license, or plan. The group contains one or more inspection lines.

Show Source

• Array of: object publicSectorInspectionGroups-InspectionGroupLine-item

{
    "items":{
        "$ref":"#/definitions/publicSectorInspectionGroups-InspectionGroupLine-item"
    },
    "type":"array",
    "description":"The inspection group resource is used to view, create, delete, or modify an inspection group. An inspection group identifies the group of inspection types associated with a permit, license, or plan. The group contains one or more inspection lines.",
    "title":"Inspection 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 : publicSectorInspectionGroups-InspectionGroupLine-item

Type: object

Show Source

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

  The unique identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the inspection group line was created.
• FinalInspectionFlag(optional): boolean
  Title: Final Inspection

  Indicates the final inspection in an inspection group. Only one inspection in the group can be selected as the final inspection. The default value is false.
• InspectionGroup(optional): string
  Title: Inspection Group

  Maximum Length: 15

  The unique identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.
• InspectionType(optional): string
  Title: Inspection Type

  Maximum Length: 15

  The unique identifier for a type of inspection.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The session login associated with the user who last updated the inspection group line.
• links(optional): array Items
  Title: Items

  Link Relations
• Required(optional): boolean
  Title: Required

  Indicates whether an inspection is required or not required. If true, the inspection is required. The default value is false.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inspection group line.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection group line was created.",
            "title":"Creation Date"
        },
        "FinalInspectionFlag":{
            "type":"boolean",
            "description":"Indicates the final inspection in an inspection group. Only one inspection in the group can be selected as the final inspection. The default value is false.",
            "title":"Final Inspection"
        },
        "InspectionGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.",
            "title":"Inspection Group"
        },
        "InspectionType":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a type of inspection.",
            "title":"Inspection Type"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection group line was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The session login associated with the user who last updated the inspection group line.",
            "title":"Last Updated By"
        },
        "Required":{
            "type":"boolean",
            "description":"Indicates whether an inspection is required or not required. If true, the inspection is required. The default value is false.",
            "title":"Required"
        },
        "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 : publicSectorInspectionGroups-item

Type: object

Show Source

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

  The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  Maximum Length: 100

  The description for a group of inspections that are associated with a permit type.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether an inspection group is available to be applied to a permit, license, or code enforcement record type. The default value is false.
• InspectionGroup(optional): string
  Title: Inspection Group

  Maximum Length: 15

  The identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.
• InspectionGroupLine(optional): array Inspection Group Lines
  Title: Inspection Group Lines

  The inspection group resource is used to view, create, delete, or modify an inspection group. An inspection group identifies the group of inspection types associated with a permit, license, or plan. The group contains one or more inspection lines.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inspection group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection group was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description for a group of inspections that are associated with a permit type.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether an inspection group is available to be applied to a permit, license, or code enforcement record type. The default value is false.",
            "title":"Enabled"
        },
        "InspectionGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.",
            "title":"Inspection Group"
        },
        "InspectionGroupLine":{
            "items":{
                "$ref":"#/definitions/publicSectorInspectionGroups-InspectionGroupLine-item"
            },
            "type":"array",
            "description":"The inspection group resource is used to view, create, delete, or modify an inspection group. An inspection group identifies the group of inspection types associated with a permit, license, or plan. The group contains one or more inspection lines.",
            "title":"Inspection Group Lines"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inspection group.",
            "title":"Last Updated By"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Inspection Group Lines

Type: array

Title: Inspection Group Lines

The inspection group resource is used to view, create, delete, or modify an inspection group. An inspection group identifies the group of inspection types associated with a permit, license, or plan. The group contains one or more inspection lines.

Show Source

• Array of: object publicSectorInspectionGroups-InspectionGroupLine-item

{
    "items":{
        "$ref":"#/definitions/publicSectorInspectionGroups-InspectionGroupLine-item"
    },
    "type":"array",
    "description":"The inspection group resource is used to view, create, delete, or modify an inspection group. An inspection group identifies the group of inspection types associated with a permit, license, or plan. The group contains one or more inspection lines.",
    "title":"Inspection 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 : publicSectorInspectionGroups-InspectionGroupLine-item

Type: object

Show Source

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

  The unique identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the inspection group line was created.
• FinalInspectionFlag(optional): boolean
  Title: Final Inspection

  Indicates the final inspection in an inspection group. Only one inspection in the group can be selected as the final inspection. The default value is false.
• InspectionGroup(optional): string
  Title: Inspection Group

  Maximum Length: 15

  The unique identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.
• InspectionType(optional): string
  Title: Inspection Type

  Maximum Length: 15

  The unique identifier for a type of inspection.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The session login associated with the user who last updated the inspection group line.
• links(optional): array Items
  Title: Items

  Link Relations
• Required(optional): boolean
  Title: Required

  Indicates whether an inspection is required or not required. If true, the inspection is required. The default value is false.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inspection group line.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection group line was created.",
            "title":"Creation Date"
        },
        "FinalInspectionFlag":{
            "type":"boolean",
            "description":"Indicates the final inspection in an inspection group. Only one inspection in the group can be selected as the final inspection. The default value is false.",
            "title":"Final Inspection"
        },
        "InspectionGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.",
            "title":"Inspection Group"
        },
        "InspectionType":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a type of inspection.",
            "title":"Inspection Type"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the inspection group line was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The session login associated with the user who last updated the inspection group line.",
            "title":"Last Updated By"
        },
        "Required":{
            "type":"boolean",
            "description":"Indicates whether an inspection is required or not required. If true, the inspection is required. The default value is false.",
            "title":"Required"
        },
        "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