Get code enforcement statuses
get
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses
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:- inspectionFinder: Finds statuses that are associated with inspections.
- caseFinder: Finds statuses that are associated with cases.
- incidentFinder: Finds statuses that are associated with incidents.
- PrimaryKey: Finds statuses that matches the specified primary key criteria. Finder Variables:
- AgencyId; integer; The unique identifier for an agency.
- Classification; string; The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection.
- Status; string; The unique identifier of a code enforcement status.
-
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 : publicSectorCodeEnforcementStatuses
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 : publicSectorCodeEnforcementStatuses-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for an agency.
-
Classification(optional):
string
Maximum Length:
15
The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the code enforcement status. -
CreationDate(optional):
string(date-time)
The date and time that the code enforcement status was created.
-
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the record is deleted. -
EnabledFlag(optional):
string
Maximum Length:
1
Indicates whether the record is enabled. -
LastUpdateDate(optional):
string(date-time)
The date and time that the code enforcement status was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the code enforcement status. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the code enforcement status. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
SeedDataLock(optional):
integer(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
-
Status(optional):
string
Title:
Status
Maximum Length:15
The unique identifier of the code enforcement status code. -
StatusName(optional):
string
Title:
Description
Maximum Length:30
The description of the code enforcement status code. -
SystemUse(optional):
string
Maximum Length:
1
Indicates whether workflow integration is active. When workflow integration is active, the workflow system makes all status changes, and users are not permitted to manually update the status.
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.