Get all object links
get
/crmRestApi/resources/11.13.18.05/objectLinks
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- ObjectLinkAltKey Finds an object link with the specified alternate unique key.
Finder Variables- LinkNumber; string; An alternate unique identifier of the object link.
- ObjectLinkByLinkNumber Finds an object link with the specified alternate unique key.
Finder Variables- LinkNumber; string; An alternate unique identifier of the object link.
- PrimaryKey Finds an object link with the specified primary key.
Finder Variables- LinkId; integer; The unique identifier of the object link.
- ObjectLinkAltKey Finds an object link with the specified alternate unique key.
-
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:- CreatedBy; string; The user who created the row.
- CreationDate; string; The date when the row was created.
- InwardCd; string; The lookup code that describes the inward direction of a link type. This field is auto generated from the value provided for short name.
- InwardCdMeaning; string; The display value of the inward lookup code for the link type used for the object link.
- LastUpdateDate; string; The date when the object link type was last updated.
- LastUpdateLogin; string; The login of the user who last updated the row.
- LastUpdatedBy; string; The user who last updated the object link type.
- LinkId; integer; The object link identifier.
- LinkNumber; string; The reference number of the object link.
- LinkTypeNumber; string; The type of link between the source and target objects.
- LinkTypeShortName; string; A unique name for the link type. The outward and inward codes are auto generated based on the short name.
- Name; string; A descriptive name for the link type.
- ObjectReference; string; Reference value that can be used to query both SourceObjectReference and TargetObjectReference.
- ObjectTypeCd; string; Lookup code that indicates the type of the Object. This can be used to query both SourceObjectTypeCd and TargetObjectTypeCd.
- OutwardCd; string; Lookup code that describes the outward direction of a link type. This field is auto generated from the value provided for short name.
- OutwardCdMeaning; string; The display value of the outward lookup code for the link type used for the object link.
- SourceObjectId; integer; The identifier of the source object.
- SourceObjectReference; string; The reference value of the source object.
- SourceObjectTypeCd; string; The lookup code that indicates the type of the source object.
- SourceObjectTypeCdMeaning; string; The display value of the source object type lookup code.
- TargetObjectId; integer; The unique identifier of the target object.
- TargetObjectReference; string; The reference value of the target object.
- TargetObjectTypeCd; string; Lookup code that indicates the type of the target object.
- TargetObjectTypeCdMeaning; string; The display value of the target object type lookup code.
-
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 : objectLinks
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 : objectLinks-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the row was created. -
DeleteFlag: boolean
Read Only:
true
Indicates if the user can delete the record. -
InwardCd: string
Title:
Inward
Read Only:true
Maximum Length:30
The lookup code that describes the inward direction of a link type. This field is auto generated from the value provided for short name. -
InwardCdMeaning: string
Title:
Inward Value
Read Only:true
Maximum Length:255
The display value of the inward lookup code for the link type used for the object link. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the object link type was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the object link type. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the row. -
LinkId: integer
Title:
Link ID
Read Only:true
The object link identifier. -
LinkNumber: string
Title:
Link Number
Maximum Length:64
The reference number of the object link. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LinkTypeNumber: string
Title:
Link Type Number
Maximum Length:64
The type of link between the source and target objects. -
LinkTypeShortName: string
Title:
Short Name
Maximum Length:20
A unique name for the link type. The outward and inward codes are auto generated based on the short name. -
Name: string
Title:
Name
Read Only:true
Maximum Length:400
A descriptive name for the link type. -
ObjectReference: string
Title:
Object Reference
Read Only:true
Reference value that can be used to query both SourceObjectReference and TargetObjectReference. -
ObjectTypeCd: string
Title:
Object Type
Read Only:true
Lookup code that indicates the type of the Object. This can be used to query both SourceObjectTypeCd and TargetObjectTypeCd. -
OutwardCd: string
Title:
Outward
Read Only:true
Maximum Length:30
Lookup code that describes the outward direction of a link type. This field is auto generated from the value provided for short name. -
OutwardCdMeaning: string
Title:
Outward Value
Read Only:true
Maximum Length:255
The display value of the outward lookup code for the link type used for the object link. -
SourceObjectId: integer
Title:
Source ID
The identifier of the source object. -
SourceObjectReference: string
Title:
Source Reference
Maximum Length:64
The reference value of the source object. -
SourceObjectTypeCd: string
Title:
Source Type
Maximum Length:30
The lookup code that indicates the type of the source object. -
SourceObjectTypeCdMeaning: string
Title:
Source Type Value
Read Only:true
Maximum Length:255
The display value of the source object type lookup code. -
TargetObjectId: integer
(int64)
Title:
Target ID
The unique identifier of the target object. -
TargetObjectReference: string
Title:
Target Reference
Maximum Length:64
The reference value of the target object. -
TargetObjectTypeCd: string
Title:
Target Type
Maximum Length:30
Lookup code that indicates the type of the target object. -
TargetObjectTypeCdMeaning: string
Title:
Target Type Value
Read Only:true
Maximum Length:255
The display value of the target object type lookup code. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record.
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.
Examples
The following example shows how to get all object links by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinks
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "LinkId": 300100547490303, "LinkNumber": "CDRM_0000014009", "SourceObjectReference": "SR0000081148", "SourceObjectTypeCd": "ServiceRequest", "SourceObjectTypeCdMeaning": "Service Request", "SourceObjectId": null, "TargetObjectReference": "SR0000011019", "TargetObjectTypeCd": "ServiceRequest", "TargetObjectTypeCdMeaning": "Service Request", "TargetObjectId": null, "LinkTypeNumber": "LT_1", "CreationDate": "2021-08-16T15:06:13+00:00", "CreatedBy": "AUTOUICASE2", "LastUpdateDate": "2021-08-16T15:06:13.126+00:00", "LastUpdatedBy": "AUTOUICASE2", "LastUpdateLogin": "C9631A5C51BC3578E0531C5CF00AC03E", "Name": "A Link Type of blocks", "OutwardCd": "ORA_SVC_BLOCKS", "InwardCd": "ORA_SVC_BLOCKS_I", "InwardCdMeaning": "Is Blocked By", "LinkTypeShortName": "BLOCKS", "ObjectTypeCd": null, "ObjectReference": null, "UpdateFlag": true, "DeleteFlag": true, ... } ] }