Get an assigned or unassigned inspection
get
/fscmRestApi/resources/11.13.18.05/publicSectorUnasgnInspections/{publicSectorUnasgnInspectionsUniqID}
Request
Path Parameters
-
publicSectorUnasgnInspectionsUniqID: integer
This is the hash key of the attributes which make up the composite key--- InspectionId and AgencyId ---for the Assigned or Unassigned Inspections resource and used to uniquely identify an instance of Assigned or Unassigned Inspections. The client should not generate the hash key value. Instead, the client should query on the Assigned or Unassigned Inspections collection resource with a filter on the primary key values in order to navigate to a specific instance of Assigned or Unassigned Inspections.
For example: publicSectorUnasgnInspections?q=InspectionId=<value1>;AgencyId=<value2>
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorUnasgnInspections-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The first line of the address on the inspection. -
Address2(optional):
string
Maximum Length:
240
The second line of the address on the inspection. -
Address3(optional):
string
Maximum Length:
240
The third line of the address on the inspection. -
Address4(optional):
string
Maximum Length:
240
The fourth line of the address on the inspection. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the inspection.
-
City(optional):
string
Maximum Length:
60
The city of the address on the inspection. -
Country(optional):
string
Maximum Length:
3
The country of the address on the inspection. -
County(optional):
string
Maximum Length:
60
The county of the address on the inspection. -
Description(optional):
string
Maximum Length:
100
The description of the inspection, which comes from the inspection type. -
EstimatedDurationHrs(optional):
number
The estimated duration of the inspection in hours.
-
InspectionDistrict(optional):
string
Maximum Length:
50
The district on the inspection. -
InspectionId(optional):
string
Maximum Length:
50
The unique identifier of the inspection. -
InspectionType(optional):
string
Maximum Length:
15
The inspection type on the inspection. -
InspectorId(optional):
integer(int64)
The unique identifier of the inspector assigned to the inspection.
-
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Maximum Length:
50
The unique identifier of the application record. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record associated with the permit.
-
PostalCode(optional):
string
Maximum Length:
60
The postal code of the address on the inspection. -
RequestedDttm(optional):
string(date-time)
The date and time after which the inspection can be performed.
-
ScheduledEndDttm(optional):
string(date-time)
The date and time that the inspection is scheduled to end.
-
ScheduledStartDttm(optional):
string(date-time)
The date and time that the inspection is scheduled to start.
-
State(optional):
string
Maximum Length:
60
The state code of the address on the inspection. -
SystemStatus(optional):
string
Maximum Length:
15
The code that represents the status of the inspection.
Nested Schema : link
Type:
Show Source
object
-
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.