1. REST API for Oracle Public Sector Compliance and Regulation Cloud
  2. Tasks
  3. Inspection Types

Get an inspection type

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes/{publicSectorInspectionTypesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- AgencyId and InspectionType ---for the Inspection Types resource and used to uniquely identify an instance of Inspection Types. The client should not generate the hash key value. Instead, the client should query on the Inspection Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Types.

    For example: publicSectorInspectionTypes?q=AgencyId=<value1>;InspectionType=<value2>
Query Parameters
  • This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : publicSectorInspectionTypes-item
Type: object
Show Source
  • 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.
  • Title: Assessment Type
    Maximum Length: 15
    The unique identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results.
  • Title: Autonumber Rule
    Maximum Length: 20
    The unique identifier for an autonumber rule that is used for generating the inspection transaction key.
  • Title: Billable
    Indicates whether the inspection is a billable transaction. The default is no.
  • Title: Bill Type
    Maximum Length: 15
    The type of invoice that is generated for the inspection transaction.
  • Title: Schedule Change Policy
    The number of hours prior to the scheduled inspection time that a user can still submit a request to cancel or reschedule an inspection.
  • Title: Checklist Group
    Maximum Length: 15
    The identifier for a collection of inspection checklists.
  • Title: Checklist
    Maximum Length: 15
    The identifier for an inspection checklist.
  • 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.
  • Title: Created By
    Maximum Length: 64
    The user who created the inspection type.
  • Title: Creation Date
    The date when the inspection type was created.
  • Title: Description
    Maximum Length: 100
    The description of the building inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.
  • 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.
  • Title: Enabled
    Indicates whether the inspection type is available to be used. If the inspection type is enabled, it can be used. The default is disabled.
  • Title: Estimated Duration in Hours
    The estimated number of hours required to perform the inspection. This information can be used for planning and scheduling.
  • Title: Hide Inspector Comments
    Indicates whether inspector comments will be hidden from public users. The default is no.
  • Title: Inspection Type
    Maximum Length: 15
    The unique identifier for a type of inspection.
  • 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.
  • Title: Last Updated Date
    The date when the inspection type was last updated.
  • Title: Last Updated By
    Maximum Length: 64
    The session login associated with the user who last updated the inspection type.
  • Items
  • 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.
  • Title: Policy Name
    Maximum Length: 200
    The name of the Oracle Policy Automation template that is associated with an inspection type.
  • Title: Policy Version
    Maximum Length: 20
    The version of the Oracle Policy Automation policy version that is associated with an inspection type.
  • 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.
  • 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.
  • 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).
  • Title: Schedule Cutoff Time
    The time value for the latest time of day when an inspection request can be submitted, updated, deleted, or canceled.
  • Title: Scheduling Method
    Maximum Length: 15
    The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
  • 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.
Back to Top