Get all connections
get
/crmRestApi/resources/11.13.18.05/fieldServiceConnections
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 a connection based on the connection unique identifier.
Finder Variables- ConnectionId; integer; The public unique identifier of the connection.
- WoConnectionByCodeFinder Finds a connection based on the connection code.
Finder Variables- ConnectionCd; string; The connection code identifier of the connection.
- PrimaryKey Finds a connection based on the connection unique identifier.
-
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.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveFlag; boolean; Indicates whether the connection is active.
- ConnectionCd; string; Value that uniquely identifies the alternate unique identifier for the connection.
- ConnectionId; integer; The unique identifier of the connection.
- ConnectionName; string; The user defined name for the connection.
- ConnectionTypeCd; string; The code that identifies the type of connection.
- CreatedBy; string; The user who created the connection.
- CreationDate; string; The date and time when the connection was created.
- DaBookingAvailableFlag; boolean; Indicates whether direct assignment booking is available for a Oracle Field Service connection.
- DaBookingAvailableMsgCd; string; The message code that identifies the reason if direct assignment booking isn't available from Oracle Field Service.
- FsInstanceName; string; The field service instance name.
- LastUpdateDate; string; Indicates the date and time when the connection was last updated.
- LastUpdatedBy; string; The user who last updated the connection.
- LastVerifiedDate; string; The date and time when the connection was last verified.
- QbBookingAvailableFlag; boolean; Indicates whether quota based booking is available for a Oracle Field Service connection.
- QbBookingAvailableMsgCd; string; The message code that identifies the reason if quota based booking isn't available from Oracle Field Service.
- UserName; string; The name of the user used to make the connection.
- WaRetrievalAvailableFlag; boolean; Indicates whether the work order area retrieval is available for a Oracle Field Service connection.
- WaRetrievalAvailableMsgCd; string; The message code that identifies the reason if work order area retrieval isn't available from Oracle Field Service.
- WskillRetrievalAvailFlag; boolean; Indicates whether the work skill retrieval is available for a Oracle Field Service connection.
- WskillRetrievalAvailMsgCd; string; The message code that identifies the reason if work skill retrieval isn't available from Oracle Field Service.
- WzoneRetrievalAvailFlag; boolean; Indicates whether the work zone retrieval is available for a Oracle Field Service connection.
- WzoneRetrievalAvailMsgCd; string; The message code that identifies the reason if work zone retrieval isn't available from Oracle Field Service.
-
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".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : fieldServiceConnections
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fieldServiceConnections-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the connection is active. -
ConnectionCd: string
Title:
Connection Code
Maximum Length:30
Value that uniquely identifies the alternate unique identifier for the connection. -
ConnectionId: integer
(int64)
Title:
Connection ID
Read Only:true
The unique identifier of the connection. -
ConnectionName: string
Title:
Connection Name
Maximum Length:80
The user defined name for the connection. -
ConnectionTypeCd: string
Title:
Connection Type Code
Maximum Length:30
The code that identifies the type of connection. -
ConnectionTypeCdMeaning: string
Title:
Connection Type
Read Only:true
The name of the connection type selected for this connection. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the connection. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the connection was created. -
DaBookingAvailableFlag: boolean
Title:
Direct Assignment Booking Available
Read Only:true
Maximum Length:1
Indicates whether direct assignment booking is available for a Oracle Field Service connection. -
DaBookingAvailableMsgCd: string
Title:
Direct Assignment Booking Available Message Code
Read Only:true
Maximum Length:30
The message code that identifies the reason if direct assignment booking isn't available from Oracle Field Service. -
DaBookingAvailMessage: string
Title:
Direct Assignment Booking Available Message
Read Only:true
Maximum Length:2000
The message providing the reason if direct assignment booking isn't available from Oracle Field Service. -
FsInstanceName: string
Title:
Field Service Instance Name
Maximum Length:24
The field service instance name. -
InitiateVerificationFlag: boolean
Title:
Initiate Verification
Maximum Length:1
Default Value:false
Indicates whether there is a request to initiate the verification. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date and time when the connection was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the connection. -
LastVerifiedDate: string
(date-time)
Title:
Last Verified Date
Read Only:true
The date and time when the connection was last verified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Password: string
Title:
Password
Maximum Length:80
The password prompt used when creating a connection to pass the password details in. -
QbBookingAvailableFlag: boolean
Title:
Quota Based Booking Available
Read Only:true
Maximum Length:1
Indicates whether quota based booking is available for a Oracle Field Service connection. -
QbBookingAvailableMsgCd: string
Title:
Quota Based Booking Available Message Code
Read Only:true
Maximum Length:30
The message code that identifies the reason if quota based booking isn't available from Oracle Field Service. -
QbBookingAvailMessage: string
Title:
Quota Based Booking Available Message
Read Only:true
Maximum Length:2000
The message that identifies the reason if quota based booking isn't available from Oracle Field Service. -
URL: string
Title:
URL
Maximum Length:250
The url used to make the connection. -
UserName: string
Title:
User Name
Maximum Length:64
The name of the user used to make the connection. -
WaRetrievalAvailableFlag: boolean
Title:
Work Order Area Retrieval Available
Read Only:true
Maximum Length:1
Indicates whether the work order area retrieval is available for a Oracle Field Service connection. -
WaRetrievalAvailableMsgCd: string
Title:
Work Order Area Retrieval Available Message Code
Read Only:true
Maximum Length:30
The message code that identifies the reason if work order area retrieval isn't available from Oracle Field Service. -
WaRetrievalAvailMessage: string
Title:
Work Order Area Retrieval Available Message
Read Only:true
Maximum Length:2000
The message that identifies the reason if work order area retrieval isn't available from Oracle Field Service. -
WskillRetrievalAvailFlag: boolean
Title:
Work Skill Retrieval Available
Read Only:true
Maximum Length:1
Indicates whether the work skill retrieval is available for a Oracle Field Service connection. -
WskillRetrievalAvailMessage: string
Title:
Work Skill Retrieval Available Message
Read Only:true
Maximum Length:2000
The message that identifies the reason if work skill retrieval isn't available from Oracle Field Service. -
WskillRetrievalAvailMsgCd: string
Title:
Work Skill Retrieval Available Message Code
Read Only:true
Maximum Length:30
The message code that identifies the reason if work skill retrieval isn't available from Oracle Field Service. -
WzoneRetrievalAvailFlag: boolean
Title:
Work Zone Retrieval Available
Read Only:true
Maximum Length:1
Indicates whether the work zone retrieval is available for a Oracle Field Service connection. -
WzoneRetrievalAvailMessage: string
Title:
Work Zone Retrieval Available Message
Read Only:true
Maximum Length:2000
The message that identifies the reason if work zone retrieval isn't available from Oracle Field Service. -
WzoneRetrievalAvailMsgCd: string
Title:
Work Zone Retrieval Available Message Code
Read Only:true
Maximum Length:30
The message code that identifies the reason if work zone retrieval isn't available from Oracle Field Service.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.