REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Get all object link types

get

/crmRestApi/resources/11.13.18.05/objectLinkTypes

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
- ObjectLinkTypeAltKey Finds an object link type with the specified alternate unique key.
  Finder Variables
  - LinkTypeNumber; string; An alternate unique identifier of the object link type.
- ObjectLinkTypeByLinkTypeNumber Finds an object link type with the specified link type number.
  Finder Variables
  - LinkTypeNumber; string; An alternate unique identifier of the object link type.
- PrimaryKey Finds an object link type with the specified primary key.
  Finder Variables
  - LinkTypeId; integer; The unique identifier of the object link type.
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.
- EnabledFlag; boolean; Indicates whether the link type can be used to create object links with.
- 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.
- 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.
- LinkTypeId; integer; The link type identifier.
- LinkTypeNumber; string; The reference number of the object link type.
- Name; string; A descriptive name for the link type.
- 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.
- ShortName; string; A unique name for the link type. The outward and inward codes are auto generated based on the short name.
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: string

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: string

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.

Response

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

Type: object

Show Source

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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/objectLinkTypes-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object objectLinkTypes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/objectLinkTypes-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : objectLinkTypes-item-response

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the user can delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the link type can be used to create object links with.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "InwardCd":{
            "title":"Inward",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that describes the inward direction of a link type. This field is auto generated from the value provided for short name.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InwardCdMeaning":{
            "title":"Inward Value",
            "maxLength":80,
            "type":"string",
            "description":"The display value of the inward lookup code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "InwardCd"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the object link type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the object link type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTypeId":{
            "title":"Link Type ID",
            "type":"integer",
            "description":"The link type identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LinkTypeNumber":{
            "title":"Link Type Number",
            "maxLength":64,
            "type":"string",
            "description":"The reference number of the object link type.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"A descriptive name for the link type.",
            "nullable":false,
            "x-queryable":true
        },
        "OutwardCd":{
            "title":"Outward",
            "maxLength":30,
            "type":"string",
            "description":"Lookup code that describes the outward direction of a link type. This field is auto generated from the value provided for short name.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OutwardCdMeaning":{
            "title":"Outward Value",
            "maxLength":80,
            "type":"string",
            "description":"The display value of the outward lookup code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "OutwardCd"
                ]
            }
        },
        "ShortName":{
            "title":"Short Name",
            "maxLength":20,
            "type":"string",
            "description":"A unique name for the link type. The outward and inward codes are auto generated based on the short name.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the user can update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Examples

The following example shows how to get all object link types 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/objectLinkTypes

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "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"
                }
            ]
        },
        {
            "LinkTypeId": 300100541277261,
            "LinkTypeNumber": "LT_1",
            "Name": "A Link Type of blocks",
            "ShortName": "BLOCKS",
            "OutwardCd": "ORA_SVC_BLOCKS",
            "InwardCd": "ORA_SVC_BLOCKS_I",
            "EnabledFlag": true,
            "CreationDate": "2021-05-29T15:39:45+00:00",
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "LastUpdateDate": "2021-08-06T11:01:01+00:00",
            "LastUpdatedBy": "AUTOUICASE2",
            "LastUpdateLogin": "C88FD85FC1EABAE8E0531C5CF00AD527",
            "OutwardCdMeaning": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ddd",
            "InwardCdMeaning": "Is Blocked By",
            "UpdateFlag": true,
            "DeleteFlag": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/LT_1",
                    "name": "objectLinkTypes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/LT_1",
                    "name": "objectLinkTypes",
                    "kind": "item"
                }
            ]
        },
...
}