Get an object link type
get
/crmRestApi/resources/11.13.18.05/objectLinkTypes/{LinkTypeNumber}
Request
Path Parameters
-
LinkTypeNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : objectLinkTypes-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. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the link type can be used to create object links with. -
InwardCd: string
Title:
Inward
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
Maximum Length:80
The display value of the inward lookup code. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LinkTypeId: integer
(int64)
Title:
Link Type ID
Read Only:true
The link type identifier. -
LinkTypeNumber: string
Title:
Link Type Number
Maximum Length:64
The reference number of the object link type. -
Name: string
Title:
Name
Maximum Length:400
A descriptive name for the link type. -
OutwardCd: string
Title:
Outward
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
Maximum Length:80
The display value of the outward lookup code. -
ShortName: 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. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user can 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.
Links
- DirectionCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_LINK_DIRECTION_CD
The list of values indicating the inward object link type codes of the Object Link Type. - finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values indicating the enabled property of Object Link Type. - finder:
Examples
The following example shows how to get an object link type by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes
Example of Response Body
The following shows an example of the response body in JSON format.
{ "LinkTypeId": 300100547970175, "LinkTypeNumber": "CDRM_4004", "Name": "Alpha", "ShortName": "Alpha", "OutwardCd": "Alpha", "InwardCd": "Alpha_I", "EnabledFlag": true, "CreationDate": "2021-08-18T13:32:25+00:00", "CreatedBy": "MHoope", "LastUpdateDate": "2021-08-18T13:32:26.684+00:00", "LastUpdatedBy": "MHoope", "LastUpdateLogin": "C96309E00F0C3562E0531C5CF00AE9FF", "OutwardCdMeaning": "Alpha Relation", "InwardCdMeaning": "Alpha Inverse Relation", "UpdateFlag": true, "DeleteFlag": true, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/CDRM_4004", "name": "objectLinkTypes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/CDRM_4004", "name": "objectLinkTypes", "kind": "item" } ] }