Get all project contacts
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjectContacts
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:- simpleSearchFinder: Finds the project contact that matches the specified keyword. Finder Variables:
- value; string; The keyword that is used to find a project contact based on the person name, address, email address, phone number, contact type, organization name, or the primary flag value.
- PrimaryKey: Finds the project contact that matches the specified primary key criteria. Finder Variables:
- ContactKey; integer; The unique identifier of the project contact.
- simpleSearchFinder: Finds the project contact that matches the specified keyword. 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 : publicSectorProjectContacts
Type:
Show Source
object-
count(optional):
integer
Title:
CountThe number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMoreIndicates 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:
ItemsThe items in the collection. -
limit(optional):
integer
Title:
LimitThe actual paging size used by the server. -
links(optional):
array Items
Title:
ItemsThe link relations associated with the resource instance. -
offset(optional):
integer
Title:
OffsetThe offset value used in the current page.
Nested Schema : Items
Type:
arrayTitle:
ItemsThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorProjectContacts-item
Type:
Show Source
object-
Address1(optional):
string
Title:
Address Line 1Maximum Length:240The first or the main address. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second address line, if applicable. -
Address3(optional):
string
Title:
Address Line 3Maximum Length:240The third address line, if applicable. -
Address4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth address line, if applicable. -
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
City(optional):
string
Title:
CityMaximum Length:60The city of the project contact. -
ContactBizPartyId(optional):
integer(int64)
The identifier of the business that is associated with the project contact.
-
ContactBizProfileId(optional):
integer(int64)
The unique identifier for the business profile of the project contact.
-
ContactId(optional):
integer(int64)
The unique identifier for the project contact.
-
ContactKey(optional):
integer(int64)
The unique identifier of the project contact.
-
ContactPartyId(optional):
integer(int64)
The identifier of the project contact.
-
ContactProfileId(optional):
integer(int64)
The unique identifier for the personal profile of the project contact.
-
ContactType(optional):
string
Title:
Contact TypeMaximum Length:30The type of contact. -
Country(optional):
string
Title:
CountryMaximum Length:3The name of the country of the contact. -
County(optional):
string
Title:
CountyMaximum Length:60The name of the county of the contact. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the project contact. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the project contact was created. -
EmailAddress(optional):
string
Title:
EmailMaximum Length:320The email address of the contact. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe name of the user who last updated the project contact. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the project contact was last updated. -
links(optional):
array Items
Title:
ItemsLink Relations -
OrganizationName(optional):
string
Title:
Organization NameMaximum Length:360The name of the organization of the project contact. -
PersonFirstName(optional):
string
Title:
First NameMaximum Length:150The first name of the project contact. -
PersonLastName(optional):
string
Title:
Last NameMaximum Length:150The last name of the project contact. -
PersonMiddleName(optional):
string
Title:
Middle NameMaximum Length:60The middle name of the project contact. -
PersonName(optional):
string
Title:
NameMaximum Length:450The name of the project contact. -
PersonNameSuffix(optional):
string
Maximum Length:
30The suffix to the name of the project contact. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30The person pre name of the adjunct. -
PersonTitle(optional):
string
Title:
TitleMaximum Length:60The title of the project contact. -
PhoneAreaCode(optional):
string
Maximum Length:
10The phone area code of the contact. -
PhoneCountryCode(optional):
string
Maximum Length:
10The phone country code of the contact. -
PhoneExtension(optional):
string
Maximum Length:
20The phone extension of the contact. -
PhoneNumber(optional):
string
Maximum Length:
40The phone number of the contact. -
PostalCode(optional):
string
Title:
Postal CodeMaximum Length:60The postal code of the project contact. -
PostalPlus4Code(optional):
string
Title:
Postal Plus 4 CodeMaximum Length:10The extended postal code of the contact. -
PrimaryFlag(optional):
string
Title:
PrimaryMaximum Length:1Indicates if the current project contact is the primary contact. The value 'Y' indicates that the project contact is the primary contact and the value 'N' indicates that the contact is not the primary contact. The default value is 'N'. -
ProjectCode(optional):
string
Title:
Project IDMaximum Length:30The unique identifier of the project. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The name of the province of the project contact. -
State(optional):
string
Title:
StateMaximum Length:60The name of the state of the project contact.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.