Jump to

• Request
• Response

Create an inspection type

post

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  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.
• AssessmentType: string
  Title: Assessment Type

  Maximum Length: 25

  The unique identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results.
• AutonumberRuleId: string
  Title: Autonumber Rule

  Maximum Length: 20

  The unique identifier for an autonumber rule that is used for generating the inspection transaction key.
• BillableFlag: boolean
  Title: Billable

  Maximum Length: 1

  Indicates whether the inspection is a billable transaction. The default is no.
• BillType: string
  Title: Bill Type

  Maximum Length: 15

  The type of invoice that is generated for the inspection transaction.
• ChangeSchedulePolicyHrs: integer (int32)
  Title: Schedule Change Policy

  The number of hours prior to the scheduled inspection time that a user can cancel or reschedule an inspection.
• ChecklistGroup: string
  Title: Checklist Group

  Maximum Length: 15

  The identifier for a collection of inspection checklists.
• ChecklistId: string
  Title: Checklist

  Maximum Length: 15

  The identifier for an inspection checklist.
• ContractorSignatureOpt: string
  Title: Contractor Signature

  Maximum Length: 3

  Indicates whether the contractor needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the building inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.
• DistrictType: string
  Title: Inspection District Type

  Maximum Length: 30

  The type of district for the inspection. Examples of an inspection district are Building, Electrical, and Plumbing inspection.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the inspection type is available to be used. If the inspection type is enabled, it can be used. The default is disabled.
• EstimatedDurationHrs: number
  Title: Estimated Duration in Hours

  The estimated number of hours required to perform the inspection. This information can be used for planning and scheduling.
• HideAssessFeeFlag: string
  Title: Hide Assess Fee Option

  Maximum Length: 1

  Default Value: N

  Indicates whether the assess fee flag is hidden when viewing inspection records.
• HideFromUserFlag: boolean
  Title: Unannounced

  Maximum Length: 1

  Default Value: false

  Indicates whether the inspection will be displayed to a nonagency user prior to completion. The default value is false, which indicates the inspection is always displayed to nonagency users.
• HideInspectorComment: boolean
  Title: Hide Inspector Comments

  Maximum Length: 1

  Indicates whether inspector comments will be hidden from public users. The default is no.
• InspectionType: string
  Title: Inspection Type

  Maximum Length: 15

  The unique identifier for a type of inspection.
• InspectorSignatureOpt: string
  Title: Inspector Signature

  Maximum Length: 3

  Indicates whether the inspector must sign the inspection report before the submitting the inspection in the system. Values include Optional, Required, and Not Required. The default is Required.
• MaximumScore: integer (int32)
  Title: Maximum Score

  The maximum inspection score that can result in the specified rating. The maximum score must be greater than the minimum score, and the score ranges for a specific rating must not overlap with the other ratings that are defined for a rating method.
• OpaPolicyName: string
  Title: Policy Name

  Maximum Length: 200

  The name of the Oracle Policy Automation template that is associated with an inspection type.
• OpaPolicyVersion: string
  Title: Policy Version

  Maximum Length: 20

  The version of the Oracle Policy Automation policy version that is associated with an inspection type.
• OwnerSignatureOpt: string
  Title: Owner Signature

  Maximum Length: 3

  Indicates whether the property owner needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.
• PassingRule: string
  Title: Passing Rule

  Maximum Length: 15

  The unique identifier for a passing rule. Passing rules provide results criteria to determine whether an inspection passes or fails.
• RatingMethod: string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used for an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).
• ScheduleCutoffTime: string (date-time)
  Title: Schedule Cutoff Time

  The time value for the latest time of day when an inspection request can be submitted, updated, deleted, or canceled.
• SchedulingMethod: string
  Title: Scheduling Method

  Maximum Length: 15

  Default Value: SCHEDULE

  The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
• ScoringMethod: string
  Title: Scoring Method

  Maximum Length: 15

  The method used for calculating the score for an inspection. For example, with the bottom up method, the inspector starts with a zero score and adds points for each criterion that is met.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for a type of inspection.",
            "nullable":false
        },
        "SchedulingMethod":{
            "title":"Scheduling Method",
            "maxLength":"15",
            "type":"string",
            "description":"The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.",
            "nullable":true,
            "default":"SCHEDULE"
        },
        "ScheduleCutoffTime":{
            "title":"Schedule Cutoff Time",
            "type":"string",
            "description":"The time value for the latest time of day when an inspection request can be submitted, updated, deleted, or canceled.",
            "format":"date-time",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the building inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "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.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "ContractorSignatureOpt":{
            "title":"Contractor Signature",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the contractor needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.",
            "nullable":true
        },
        "ChecklistId":{
            "title":"Checklist",
            "maxLength":"15",
            "type":"string",
            "description":"The identifier for an inspection checklist.",
            "nullable":true
        },
        "PassingRule":{
            "title":"Passing Rule",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for a passing rule. Passing rules provide results criteria to determine whether an inspection passes or fails.",
            "nullable":true
        },
        "RatingMethod":{
            "title":"Rating Method",
            "maxLength":"15",
            "type":"string",
            "description":"The unique code to identify the rating method used for an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "nullable":true
        },
        "ChangeSchedulePolicyHrs":{
            "title":"Schedule Change Policy",
            "type":"integer",
            "description":"The number of hours prior to the scheduled inspection time that a  user can cancel or reschedule an inspection.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            }
        },
        "AutonumberRuleId":{
            "title":"Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier for an autonumber rule that is used for generating the inspection transaction key.",
            "nullable":false
        },
        "HideFromUserFlag":{
            "title":"Unannounced",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the inspection will be displayed to a nonagency user prior to completion. The default value is false, which indicates the inspection is always displayed to nonagency users.",
            "nullable":false,
            "default":false
        },
        "EstimatedDurationHrs":{
            "title":"Estimated Duration in Hours",
            "type":"number",
            "description":"The estimated number of hours required to perform the inspection. This information can be used for planning and scheduling.",
            "nullable":false,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "OpaPolicyVersion":{
            "title":"Policy Version",
            "maxLength":"20",
            "type":"string",
            "description":"The version of the Oracle Policy Automation policy version that is associated with an inspection type.",
            "nullable":true
        },
        "AssessmentType":{
            "title":"Assessment Type",
            "maxLength":"25",
            "type":"string",
            "description":"The unique identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results.",
            "nullable":false
        },
        "ScoringMethod":{
            "title":"Scoring Method",
            "maxLength":"15",
            "type":"string",
            "description":"The method used for calculating the score for an inspection. For example, with the bottom up method, the inspector starts with a zero score and adds points for each criterion that is met.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the inspection type is available to be used. If the inspection type is enabled, it can be used. The default is disabled.",
            "nullable":false
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"integer",
            "description":"The maximum inspection score that can result in the specified rating. The maximum score must be greater than the minimum score, and the score ranges for a specific rating must not overlap with the other ratings that are defined for a rating method.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            }
        },
        "BillType":{
            "title":"Bill Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of invoice that is generated for the inspection transaction.",
            "nullable":true
        },
        "OpaPolicyName":{
            "title":"Policy Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the Oracle Policy Automation template that is associated with an inspection type.",
            "nullable":true
        },
        "DistrictType":{
            "title":"Inspection District Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of district for the inspection. Examples of an inspection district are Building, Electrical, and Plumbing inspection.",
            "nullable":true
        },
        "BillableFlag":{
            "title":"Billable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the inspection is a billable transaction. The default is no.",
            "nullable":false
        },
        "ChecklistGroup":{
            "title":"Checklist Group",
            "maxLength":"15",
            "type":"string",
            "description":"The identifier for  a collection of inspection checklists.",
            "nullable":true
        },
        "InspectorSignatureOpt":{
            "title":"Inspector Signature",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the inspector must sign the inspection report before the submitting the inspection in the system. Values include Optional, Required, and Not Required. The default is Required.",
            "nullable":true
        },
        "HideInspectorComment":{
            "title":"Hide Inspector Comments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether inspector comments will be hidden from public users. The default is no.",
            "nullable":false
        },
        "HideAssessFeeFlag":{
            "title":"Hide Assess Fee Option",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the assess fee flag is hidden when viewing inspection records.",
            "nullable":false,
            "default":"N"
        },
        "OwnerSignatureOpt":{
            "title":"Owner Signature",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the property owner needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.",
            "nullable":true
        }
    }
}

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 : publicSectorInspectionTypes-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  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.
• AssessmentType: string
  Title: Assessment Type

  Maximum Length: 25

  The unique identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results.
• AutonumberRuleId: string
  Title: Autonumber Rule

  Maximum Length: 20

  The unique identifier for an autonumber rule that is used for generating the inspection transaction key.
• BillableFlag: boolean
  Title: Billable

  Maximum Length: 1

  Indicates whether the inspection is a billable transaction. The default is no.
• BillType: string
  Title: Bill Type

  Maximum Length: 15

  The type of invoice that is generated for the inspection transaction.
• ChangeSchedulePolicyHrs: integer (int32)
  Title: Schedule Change Policy

  The number of hours prior to the scheduled inspection time that a user can cancel or reschedule an inspection.
• ChecklistGroup: string
  Title: Checklist Group

  Maximum Length: 15

  The identifier for a collection of inspection checklists.
• ChecklistId: string
  Title: Checklist

  Maximum Length: 15

  The identifier for an inspection checklist.
• ContractorSignatureOpt: string
  Title: Contractor Signature

  Maximum Length: 3

  Indicates whether the contractor needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the inspection type was created.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the building inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.
• DistrictType: string
  Title: Inspection District Type

  Maximum Length: 30

  The type of district for the inspection. Examples of an inspection district are Building, Electrical, and Plumbing inspection.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the inspection type is available to be used. If the inspection type is enabled, it can be used. The default is disabled.
• EstimatedDurationHrs: number
  Title: Estimated Duration in Hours

  The estimated number of hours required to perform the inspection. This information can be used for planning and scheduling.
• HideAssessFeeFlag: string
  Title: Hide Assess Fee Option

  Maximum Length: 1

  Default Value: N

  Indicates whether the assess fee flag is hidden when viewing inspection records.
• HideFromUserFlag: boolean
  Title: Unannounced

  Maximum Length: 1

  Default Value: false

  Indicates whether the inspection will be displayed to a nonagency user prior to completion. The default value is false, which indicates the inspection is always displayed to nonagency users.
• HideInspectorComment: boolean
  Title: Hide Inspector Comments

  Maximum Length: 1

  Indicates whether inspector comments will be hidden from public users. The default is no.
• InspectionType: string
  Title: Inspection Type

  Maximum Length: 15

  The unique identifier for a type of inspection.
• InspectorSignatureOpt: string
  Title: Inspector Signature

  Maximum Length: 3

  Indicates whether the inspector must sign the inspection report before the submitting the inspection in the system. Values include Optional, Required, and Not Required. The default is Required.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the inspection type was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumScore: integer (int32)
  Title: Maximum Score

  The maximum inspection score that can result in the specified rating. The maximum score must be greater than the minimum score, and the score ranges for a specific rating must not overlap with the other ratings that are defined for a rating method.
• OpaPolicyName: string
  Title: Policy Name

  Maximum Length: 200

  The name of the Oracle Policy Automation template that is associated with an inspection type.
• OpaPolicyVersion: string
  Title: Policy Version

  Maximum Length: 20

  The version of the Oracle Policy Automation policy version that is associated with an inspection type.
• OwnerSignatureOpt: string
  Title: Owner Signature

  Maximum Length: 3

  Indicates whether the property owner needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.
• PassingRule: string
  Title: Passing Rule

  Maximum Length: 15

  The unique identifier for a passing rule. Passing rules provide results criteria to determine whether an inspection passes or fails.
• RatingMethod: string
  Title: Rating Method

  Maximum Length: 15

  The unique code to identify the rating method used for an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).
• ScheduleCutoffTime: string (date-time)
  Title: Schedule Cutoff Time

  The time value for the latest time of day when an inspection request can be submitted, updated, deleted, or canceled.
• SchedulingMethod: string
  Title: Scheduling Method

  Maximum Length: 15

  Default Value: SCHEDULE

  The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
• ScoringMethod: string
  Title: Scoring Method

  Maximum Length: 15

  The method used for calculating the score for an inspection. For example, with the bottom up method, the inspector starts with a zero score and adds points for each criterion that is met.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for a type of inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "SchedulingMethod":{
            "title":"Scheduling Method",
            "maxLength":"15",
            "type":"string",
            "description":"The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.",
            "nullable":true,
            "default":"SCHEDULE",
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inspection type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleCutoffTime":{
            "title":"Schedule Cutoff Time",
            "type":"string",
            "description":"The time value for the latest time of day when an inspection request can be submitted, updated, deleted, or canceled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the building inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "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.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ContractorSignatureOpt":{
            "title":"Contractor Signature",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the contractor needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.",
            "nullable":true,
            "x-queryable":true
        },
        "ChecklistId":{
            "title":"Checklist",
            "maxLength":"15",
            "type":"string",
            "description":"The identifier for an inspection checklist.",
            "nullable":true,
            "x-queryable":true
        },
        "PassingRule":{
            "title":"Passing Rule",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for a passing rule. Passing rules provide results criteria to determine whether an inspection passes or fails.",
            "nullable":true,
            "x-queryable":true
        },
        "RatingMethod":{
            "title":"Rating Method",
            "maxLength":"15",
            "type":"string",
            "description":"The unique code to identify the rating method used for an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeSchedulePolicyHrs":{
            "title":"Schedule Change Policy",
            "type":"integer",
            "description":"The number of hours prior to the scheduled inspection time that a  user can cancel or reschedule an inspection.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "AutonumberRuleId":{
            "title":"Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier for an autonumber rule that is used for generating the inspection transaction key.",
            "nullable":false,
            "x-queryable":true
        },
        "HideFromUserFlag":{
            "title":"Unannounced",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the inspection will be displayed to a nonagency user prior to completion. The default value is false, which indicates the inspection is always displayed to nonagency users.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EstimatedDurationHrs":{
            "title":"Estimated Duration in Hours",
            "type":"number",
            "description":"The estimated number of hours required to perform the inspection. This information can be used for planning and scheduling.",
            "nullable":false,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "OpaPolicyVersion":{
            "title":"Policy Version",
            "maxLength":"20",
            "type":"string",
            "description":"The version of the Oracle Policy Automation policy version that is associated with an inspection type.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentType":{
            "title":"Assessment Type",
            "maxLength":"25",
            "type":"string",
            "description":"The unique identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ScoringMethod":{
            "title":"Scoring Method",
            "maxLength":"15",
            "type":"string",
            "description":"The method used for calculating the score for an inspection. For example, with the bottom up method, the inspector starts with a zero score and adds points for each criterion that is met.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the inspection type is available to be used. If the inspection type is enabled, it can be used. The default is disabled.",
            "nullable":false,
            "x-queryable":true
        },
        "MaximumScore":{
            "title":"Maximum Score",
            "type":"integer",
            "description":"The maximum inspection score that can result in the specified rating. The maximum score must be greater than the minimum score, and the score ranges for a specific rating must not overlap with the other ratings that are defined for a rating method.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "BillType":{
            "title":"Bill Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of invoice that is generated for the inspection transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "OpaPolicyName":{
            "title":"Policy Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the Oracle Policy Automation template that is associated with an inspection type.",
            "nullable":true,
            "x-queryable":true
        },
        "DistrictType":{
            "title":"Inspection District Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of district for the inspection. Examples of an inspection district are Building, Electrical, and Plumbing inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "BillableFlag":{
            "title":"Billable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the inspection is a billable transaction. The default is no.",
            "nullable":false,
            "x-queryable":true
        },
        "ChecklistGroup":{
            "title":"Checklist Group",
            "maxLength":"15",
            "type":"string",
            "description":"The identifier for  a collection of inspection checklists.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectorSignatureOpt":{
            "title":"Inspector Signature",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the inspector must sign the inspection report before the submitting the inspection in the system. Values include Optional, Required, and Not Required. The default is Required.",
            "nullable":true,
            "x-queryable":true
        },
        "HideInspectorComment":{
            "title":"Hide Inspector Comments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether inspector comments will be hidden from public users. The default is no.",
            "nullable":false,
            "x-queryable":true
        },
        "HideAssessFeeFlag":{
            "title":"Hide Assess Fee Option",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the assess fee flag is hidden when viewing inspection records.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "OwnerSignatureOpt":{
            "title":"Owner Signature",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the property owner needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inspection type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Back to Top