Jump to

• Request
• Response

Create an inspection group line

post

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroupLines

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

Type: object

Show Source

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

  The identifier for a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when an inspection was added to the group.
• DependentInspectionTypeCode(optional): string
  Maximum Length: 2000

  The dependent inspection types defined for this inspection type
• DependentInspectionTypeDescr(optional): string
  Maximum Length: 2500

  The descriptions of the dependent inspection types defined for this inspection type.
• FinalInspectionFlag(optional): boolean
  Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.
• InspectionGroup(optional): string
  Maximum Length: 15

  The unique identifier for a group of inspections that are associated with a record type, such as a permit.
• InspectionGrpLnDependency(optional): array Inspection Type Dependencies
  Title: Inspection Type Dependencies

  The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.
• InspectionType(optional): string
  Maximum Length: 15

  The unique identifier for a type of inspection, such as an electrical or plumbing inspection.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

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

  Indicates whether the inspection is required. The default value is false.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier for a public sector agency.",
            "type":"integer",
            "format":"int64"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who added an inspection to the group.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date when an inspection was added to the group.",
            "type":"string",
            "format":"date-time"
        },
        "DependentInspectionTypeCode":{
            "description":"The dependent inspection types defined for this inspection type",
            "type":"string",
            "maxLength":2000
        },
        "DependentInspectionTypeDescr":{
            "description":"The descriptions of the dependent inspection types defined for this inspection type.",
            "type":"string",
            "maxLength":2500
        },
        "FinalInspectionFlag":{
            "description":"Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.",
            "type":"boolean"
        },
        "InspectionGroup":{
            "description":"The unique identifier for a group of inspections that are associated with a record type, such as a permit.",
            "type":"string",
            "maxLength":15
        },
        "InspectionGrpLnDependency":{
            "title":"Inspection Type Dependencies",
            "description":"The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorInspectionGroupLines-InspectionGrpLnDependency-item"
            }
        },
        "InspectionType":{
            "description":"The unique identifier for a type of inspection, such as an electrical or plumbing inspection.",
            "type":"string",
            "maxLength":15
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date when an inspection in the group was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated an inspection in the group.",
            "type":"string",
            "maxLength":64
        },
        "Required":{
            "title":"Required",
            "description":"Indicates whether the inspection is required. The default value is false.",
            "type":"boolean"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Inspection Type Dependencies

Type: array

Title: Inspection Type Dependencies

The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.

Show Source

• Array of: object publicSectorInspectionGroupLines-InspectionGrpLnDependency-item

{
    "title":"Inspection Type Dependencies",
    "description":"The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorInspectionGroupLines-InspectionGrpLnDependency-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : publicSectorInspectionGroupLines-InspectionGrpLnDependency-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with the inspection.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the dependent inspection type was added to the inspection type.
• DependentInspectionType(optional): string
  Maximum Length: 15

  The dependent inspection type for the inspection type.
• Description(optional): string
  Maximum Length: 255

  The description of the inspection type.
• InspectionGroup(optional): string
  Maximum Length: 15

  The inspection group that includes the dependent inspection type.
• InspectionType(optional): string
  Maximum Length: 15

  The inspection type for which the dependent inspection type is defined.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the dependent inspection type was last updated.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier for the public sector agency associated with the inspection.",
            "type":"integer",
            "format":"int64"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date when the dependent inspection type was added to the inspection type.",
            "type":"string",
            "format":"date-time"
        },
        "DependentInspectionType":{
            "description":"The dependent inspection type for the inspection type.",
            "type":"string",
            "maxLength":15
        },
        "Description":{
            "description":"The description of the inspection type.",
            "type":"string",
            "maxLength":255
        },
        "InspectionGroup":{
            "description":"The inspection group that includes the dependent inspection type.",
            "type":"string",
            "maxLength":15
        },
        "InspectionType":{
            "description":"The inspection type for which the dependent inspection type is defined.",
            "type":"string",
            "maxLength":15
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date when the dependent inspection type was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

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

Type: object

Show Source

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

  The identifier for a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when an inspection was added to the group.
• DependentInspectionTypeCode(optional): string
  Maximum Length: 2000

  The dependent inspection types defined for this inspection type
• DependentInspectionTypeDescr(optional): string
  Maximum Length: 2500

  The descriptions of the dependent inspection types defined for this inspection type.
• FinalInspectionFlag(optional): boolean
  Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.
• InspectionGroup(optional): string
  Maximum Length: 15

  The unique identifier for a group of inspections that are associated with a record type, such as a permit.
• InspectionGrpLnDependency(optional): array Inspection Type Dependencies
  Title: Inspection Type Dependencies

  The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.
• InspectionType(optional): string
  Maximum Length: 15

  The unique identifier for a type of inspection, such as an electrical or plumbing inspection.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

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

  Indicates whether the inspection is required. The default value is false.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier for a public sector agency.",
            "type":"integer",
            "format":"int64"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who added an inspection to the group.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date when an inspection was added to the group.",
            "type":"string",
            "format":"date-time"
        },
        "DependentInspectionTypeCode":{
            "description":"The dependent inspection types defined for this inspection type",
            "type":"string",
            "maxLength":2000
        },
        "DependentInspectionTypeDescr":{
            "description":"The descriptions of the dependent inspection types defined for this inspection type.",
            "type":"string",
            "maxLength":2500
        },
        "FinalInspectionFlag":{
            "description":"Indicates which inspection is the final inspection in the group. Only one inspection can be selected as the final inspection.",
            "type":"boolean"
        },
        "InspectionGroup":{
            "description":"The unique identifier for a group of inspections that are associated with a record type, such as a permit.",
            "type":"string",
            "maxLength":15
        },
        "InspectionGrpLnDependency":{
            "title":"Inspection Type Dependencies",
            "description":"The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorInspectionGroupLines-InspectionGrpLnDependency-item"
            }
        },
        "InspectionType":{
            "description":"The unique identifier for a type of inspection, such as an electrical or plumbing inspection.",
            "type":"string",
            "maxLength":15
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date when an inspection in the group was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated an inspection in the group.",
            "type":"string",
            "maxLength":64
        },
        "Required":{
            "title":"Required",
            "description":"Indicates whether the inspection is required. The default value is false.",
            "type":"boolean"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Inspection Type Dependencies

Type: array

Title: Inspection Type Dependencies

The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.

Show Source

• Array of: object publicSectorInspectionGroupLines-InspectionGrpLnDependency-item

{
    "title":"Inspection Type Dependencies",
    "description":"The inspection type dependencies resource provides all inspection types and their dependencies within an inspection group.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/publicSectorInspectionGroupLines-InspectionGrpLnDependency-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : publicSectorInspectionGroupLines-InspectionGrpLnDependency-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with the inspection.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the dependent inspection type was added to the inspection type.
• DependentInspectionType(optional): string
  Maximum Length: 15

  The dependent inspection type for the inspection type.
• Description(optional): string
  Maximum Length: 255

  The description of the inspection type.
• InspectionGroup(optional): string
  Maximum Length: 15

  The inspection group that includes the dependent inspection type.
• InspectionType(optional): string
  Maximum Length: 15

  The inspection type for which the dependent inspection type is defined.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the dependent inspection type was last updated.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier for the public sector agency associated with the inspection.",
            "type":"integer",
            "format":"int64"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date when the dependent inspection type was added to the inspection type.",
            "type":"string",
            "format":"date-time"
        },
        "DependentInspectionType":{
            "description":"The dependent inspection type for the inspection type.",
            "type":"string",
            "maxLength":15
        },
        "Description":{
            "description":"The description of the inspection type.",
            "type":"string",
            "maxLength":255
        },
        "InspectionGroup":{
            "description":"The inspection group that includes the dependent inspection type.",
            "type":"string",
            "maxLength":15
        },
        "InspectionType":{
            "description":"The inspection type for which the dependent inspection type is defined.",
            "type":"string",
            "maxLength":15
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date when the dependent inspection type was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top