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

Update an object link type

patch

/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=

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

EnabledFlag: boolean

Title: Enabled

Maximum Length: 1

Default Value: true

Indicates whether the link type can be used to create object links with.
InwardCdMeaning: string

Title: Inward Value

Maximum Length: 80

The display value of the inward lookup code.
Name: string

Title: Name

Maximum Length: 400

A descriptive name for the link type.
OutwardCdMeaning: string

Title: Outward Value

Maximum Length: 80

The display value of the outward lookup code.

{
    "type":"object",
    "properties":{
        "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"
                ]
            }
        },
        "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"
            }
        },
        "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"
                ]
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"400",
            "type":"string",
            "description":"A descriptive name for the link type.",
            "nullable":false
        }
    }
}

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-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":{
        "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
        },
        "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "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"
                ]
            }
        },
        "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
        },
        "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"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"400",
            "type":"string",
            "description":"A descriptive name for the link type.",
            "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"
            }
        },
        "LinkTypeNumber":{
            "title":"Link Type Number",
            "maxLength":"64",
            "type":"string",
            "description":"The reference number of the object link type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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"
                ]
            }
        },
        "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
        }
    }
}

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."
        }
    }
}

Links

DirectionCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

YesNoLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating the enabled property of Object Link Type.

Examples

The following example shows how to update an object link type by submitting a patch request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/{LinkTypeNumber}

Example of Request Body

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

{
    "Name": "Alpha Object Link Type",
    "EnabledFlag": false
}

Example of Response Body

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

{
    "LinkTypeId": 300100548010602,
    "LinkTypeNumber": "CDRM_4006",
    "Name": "Alpha Object Link Type",
    "ShortName": "BETA",
    "OutwardCd": "BETA",
    "InwardCd": "BETA_I",
    "EnabledFlag": false,
    "CreationDate": "2021-08-19T05:46:43+00:00",
    "CreatedBy": "MHoope",
    "LastUpdateDate": "2021-08-19T05:50:13+00:00",
    "LastUpdatedBy": "MHoope",
    "LastUpdateLogin": "C9911F1C4349AE2CE0531C5CF00A83C4",
    "OutwardCdMeaning": "Beta Relation",
    "InwardCdMeaning": "Beta Inverse Relation",
    "UpdateFlag": true,
    "DeleteFlag": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/CDRM_4006",
            "name": "objectLinkTypes",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/CDRM_4006",
            "name": "objectLinkTypes",
            "kind": "item"
        }
    ]
}