Get all project information
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjectAPOSearches
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:- PrimaryKey: Finds the project that matches the primary key criteria. Finder Variables:
- AddressKey; integer; The unique identifier of the project address.
- AgencyId; integer; The identifier of the agency to which the project belongs.
- ParcelKey; integer; The unique identifier of the project parcel.
- ProjectCode; string; The unique identifier string of the project.
- PrimaryKey: Finds the project that matches the primary key 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 : publicSectorProjectAPOSearches
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 : publicSectorProjectAPOSearches-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The first line for the main address. -
Address2(optional):
string
Maximum Length:
240
The second line for the address, if applicable. -
Address3(optional):
string
Maximum Length:
240
The third line for the address, if applicable. -
Address4(optional):
string
Maximum Length:
240
The fourth line for the address, if applicable. -
AddressId(optional):
integer(int64)
The identifier of the parcel address.
-
AddressKey(optional):
integer(int64)
The unique identifier of the project address.
-
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
City(optional):
string
Maximum Length:
60
The name of the city as entered in the parcel address. -
Country(optional):
string
Maximum Length:
60
The name of the country in the parcel address. -
County(optional):
string
Maximum Length:
60
The name of the county in the parcel address. -
CreationDate(optional):
string(date-time)
The date when the project was created.
-
EndDate(optional):
string(date-time)
The end date of the project.
-
LatitudeAdr(optional):
number
The latitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance.
-
LatitudePar(optional):
number
The geographic location of the parcel that is north or south of the equator.
-
links(optional):
array Items
Title:
Items
Link Relations -
LongitudeAdr(optional):
number
The longitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance.
-
LongitudePar(optional):
number
The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
-
Meaning(optional):
string
Maximum Length:
80
The meaning of the project status. The meaning can be active, inactive, on hold, completed, or canceled. The default value is active. -
MunicipalityId(optional):
string
Maximum Length:
20
The municipality identifier if the parcel is not managed at the county level. -
ParcelId(optional):
integer(int64)
The identifier of the project parcel.
-
ParcelIdEntered(optional):
string
Maximum Length:
30
The Assessor Parcel Number (APN) identifier as entered by the user. -
ParcelKey(optional):
integer(int64)
The unique identifier of the project parcel.
-
PostalCode(optional):
string
Maximum Length:
60
The postal code as entered in the parcel address. -
ProjectAdmin(optional):
integer(int64)
The project manager for the project.
-
ProjectAdminBizProfileId(optional):
integer(int64)
The identifier of the project manager business profile.
-
ProjectAdminProfileId(optional):
integer(int64)
The profile identifier of the project manager.
-
ProjectCode(optional):
string
Maximum Length:
30
The unique identifier of the project. -
ProjectName(optional):
string
Maximum Length:
50
The name for the project. -
ProjectSummary(optional):
string
Maximum Length:
500
A brief description of the project. -
ProjectType(optional):
string
Maximum Length:
50
The type of project. The values are configured in the Project Type Setup page. -
StartDate(optional):
string(date-time)
The start date of the project.
-
State(optional):
string
Maximum Length:
60
The name of the state in the parcel address. -
Status(optional):
string
Maximum Length:
7
The status of the project. The status values can be ORA_ACT, ORA_INA, ORA_ONH, ORA_COM, or ORA_CAN.
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.