Get all the project record inspections
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections
Request
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- InspectionsByDateFinder: Finds the record inspections assigned to a project that match the specified finder criteria. Finder Variables:
- Bind_EndDate; string; Finds the record inspections assigned to a project that match the specified date criteria.
- Bind_StartDate; string; Finds the record inspections assigned to a project that match the specified date criteria.
- simpleSearchFinder: Finds the record inspection assigned to a project that matches the specified keyword. Finder Variables:
- value; string; The keyword used to find the inspection of the record assigned to a project.
- PrimaryKey: Finds the row that matches the specified primary key. Finder Variables:
- InspectionId; string; The unique identifier of the inspection.
- ProjectCode; string; The unique identifier string for the project.
- RecordKey; integer; The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.
- InspectionsByDateFinder: Finds the record inspections assigned to a project that match the specified finder criteria. Finder Variables:
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorProjectRecordInspections
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorProjectRecordInspections-item
Type:
Show Source
object
-
ActlTravelTimeFromHrs(optional):
number
The number of hours taken by the inspector to return home or office from the inspection site.
-
ActlTravelTimeToHrs(optional):
number
The number of hours taken by the inspector to arrive at the inspection site from home or office.
-
ActualDurationHrs(optional):
number
The actual number of hours taken to complete the inspection.
-
ActualEndDttm(optional):
string(date-time)
The actual date and time when the inspection ended.
-
ActualStartDttm(optional):
string(date-time)
The actual date and time when the inspection started.
-
Address1(optional):
string
Maximum Length:
240
The first or main address. -
Address2(optional):
string
Maximum Length:
240
The second address, if available. -
Address3(optional):
string
Maximum Length:
240
The third address, if available. -
Address4(optional):
string
Maximum Length:
240
The fourth address, if available. -
AddressId(optional):
integer(int64)
The identifier of the parcel address.
-
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
ApplicantBizProfileId(optional):
integer(int64)
The profile ID of the business of the applicant.
-
ApplicantProfileId(optional):
integer(int64)
The profile ID of the applicant.
-
BillableFlag(optional):
string
Maximum Length:
1
Indicates whether the inspection is a billable transaction. The default value is No. -
BillType(optional):
string
Maximum Length:
15
The type of invoice that is generated for the inspection transaction. -
CancellationReason(optional):
string
Maximum Length:
150
The reason for cancellation. -
City(optional):
string
Maximum Length:
60
The city of the inspection location. -
ContactEmail(optional):
string
Maximum Length:
320
The email address of the contact. -
ContactName(optional):
string
Maximum Length:
450
The name of the contact. -
ContractorName(optional):
string
Maximum Length:
360
The name of the contractor. -
ContractorSignature(optional):
string(binary)
The signature of the contractor.
-
ContractorSignatureDttm(optional):
string(date-time)
The date and time when the contractor signed.
-
CoordinateX(optional):
number
The x-axis coordinate value of the inspection location.
-
CoordinateY(optional):
number
The y-axis coordinate value of the inspection location.
-
Country(optional):
string
Maximum Length:
3
The country in which the inspection is required. -
County(optional):
string
Maximum Length:
60
The county of the inspection location. -
CreatedBy(optional):
string
Maximum Length:
64
The name of the user who created the inspection. -
CreationDate(optional):
string(date-time)
The date when the inspection was created.
-
Description(optional):
string
Maximum Length:
100
The description of the inspection. -
DistanceUom(optional):
string
Maximum Length:
3
The unit of measure for the distance in miles or kilometers for the inspection site. -
EstimatedDurationHrs(optional):
number
The estimated number of hours required to perform the inspection. This information can be used for planning and scheduling.
-
EstimatedTimeArrival(optional):
string(date-time)
The estimated time of arrival of the inspector at the inspection location.
-
EstimatedTimeArrivalEnd(optional):
string(date-time)
The latest estimated time of arrival at the inspection site.
-
FinalInspectionFlag(optional):
string
Maximum Length:
1
The option that indicates if the inspection type is final. -
HideInspectorComment(optional):
string
Maximum Length:
1
The option to hide the comments entered by the inspector. -
InspectionCompleteDttm(optional):
string(date-time)
The date and time when the inspection was completed.
-
InspectionDistrictId(optional):
string
Maximum Length:
30
The unique identifier of the inspection location district. -
InspectionId(optional):
string
Title:
Inspection
Maximum Length:50
The unique identifier of the inspection. -
InspectionLocation(optional):
string
Maximum Length:
100
The descriptive location of the inspection. -
InspectionName(optional):
string
Maximum Length:
100
The name of the inspection. -
InspectionRating(optional):
string
Maximum Length:
5
The rating of the inspection based on the range of scores defined by the agency. -
InspectionResult(optional):
string
Title:
Result
Maximum Length:15
The final result of the inspection. If scoring is used, the result appears after you complete the inspection checklists and submit the complete inspection with required signatures. -
InspectionScore(optional):
integer(int32)
The final score of the inspection that is calculated based on the entries for the checklist items.
-
InspectionStatus(optional):
string
Title:
Status
Maximum Length:15
The name of the inspection status. The status name is used as the display status for the inspection in the permit application. -
InspectionType(optional):
string
Title:
Inspection Type
Maximum Length:15
The unique identifier of the type of inspection. -
InspectorId(optional):
integer(int64)
The unique identifier of the inspector.
-
InspectorInitials(optional):
string
Maximum Length:
6
The initials of the inspector. -
InspectorName(optional):
string
Title:
Inspector
Maximum Length:360
The name of the inspector. -
InspectorSignature(optional):
string(binary)
The signature of the inspector.
-
InspectorSignatureDttm(optional):
string(date-time)
The date and time when the inspector signed.
-
LastUpdateDate(optional):
string(date-time)
The date when the inspection was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The name of the user who last updated the inspection. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit
Maximum Length:50
The identifier of the application record. The value is generated based on the auto number rule configured for the type of record. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record.
-
LocationLatitude(optional):
number
The latitude of the inspection location.
-
LocationLongitude(optional):
number
The longitude of the inspection location.
-
NumMajorViolations(optional):
integer(int32)
The total number of violations found in the inspection. A failing result for an inspection checklist item constitutes a major violation.
-
OwnerName(optional):
string
Maximum Length:
360
The name of the owner. -
OwnerSignature(optional):
string(binary)
The signature of the owner.
-
OwnerSignatureDttm(optional):
string(date-time)
The date and time when the owner signed.
-
ParcelId(optional):
integer(int64)
The identifier of the parcel.
-
PhoneAreaCode(optional):
string
Maximum Length:
10
The area code of the phone number. -
PhoneCountryCode(optional):
string
Maximum Length:
10
The country code of the phone number. -
PhoneExtension(optional):
string
Maximum Length:
20
The extension of the phone number. -
PhoneNumber(optional):
string
Maximum Length:
40
The phone number of the contact person. -
PostalCode(optional):
string
Maximum Length:
60
The postal code of the inspection location. -
PostalPlus4Code(optional):
string
Maximum Length:
10
The extended postal code of the inspection location. -
PreferredContactMethod(optional):
string
Maximum Length:
30
The preferred mode of communication. -
ProjectCode(optional):
string
Maximum Length:
255
The unique identifier of the project. -
Province(optional):
string
Maximum Length:
60
The province of the inspection location. -
ReadyByDttm(optional):
string(date-time)
The date and time after which the inspection can be performed.
-
RecordId(optional):
string
Maximum Length:
50
The identifier of the application record. The value is generated based on the auto number rule configured for the type of record. -
RecordKey(optional):
integer(int64)
The unique identifier of the record.
-
RecordType(optional):
string
Title:
Permit Type
Maximum Length:100
The type of the record. -
ReinspectionFlag(optional):
string
Maximum Length:
1
The option to indicate if this is a re-inspection. -
RequestorComment(optional):
string
Maximum Length:
500
The comment entered by the inspection requestor. -
ScheduledEndDttm(optional):
string(date-time)
The date and time when the inspection is scheduled to end.
-
ScheduledStartDttm(optional):
string(date-time)
The date and time when the inspection is scheduled to start.
-
Srid(optional):
integer(int64)
The SRID value of the inspection location. This Spatial Reference System Identifier (SRID) is a unique value that identifies the projected, not projected, and local spatial coordinate system definitions for the inspection location. These are commonly used in most GIS systems.
-
State(optional):
string
Maximum Length:
60
The state of the inspection location. -
StatusTime(optional):
string(date-time)
The date and time when the status was set.
-
SubmitDate(optional):
string(date-time)
The date and time when the permit was submitted.
-
SystemResult(optional):
string
Maximum Length:
20
The result of the inspection as defined in the system. -
SystemStatus(optional):
string
Maximum Length:
15
The system defined status for the inspection. -
TravelFromActualDistance(optional):
number
The actual distance from the inspection site.
-
TravelFromEndOdometer(optional):
number
The odometer reading value when the inspector reaches the next location from the inspection site.
-
TravelFromStartOdometer(optional):
number
The odometer reading value when the inspector starts from the inspection site.
-
TravelToActualDistance(optional):
number
The actual distance to the inspection site.
-
TravelToEndOdometer(optional):
number
The odometer reading value when the inspector reaches the inspection site.
-
TravelToStartOdometer(optional):
number
The odometer reading value when the inspector starts to the inspection site.
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.