Jump to

• Request
• Response

Update an object link

patch

/crmRestApi/resources/11.13.18.05/objectLinks/{LinkNumber}

Request

Path Parameters

• LinkNumber(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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• LinkTypeNumber: string
  Title: Link Type Number

  Maximum Length: 64

  The type of link between the source and target objects.
• ObjectReference: string
  Title: Object Reference

  Reference value that can be used to query both SourceObjectReference and TargetObjectReference.
• ObjectTypeCd: string
  Title: Object Type

  Lookup code that indicates the type of the Object. This can be used to query both SourceObjectTypeCd and TargetObjectTypeCd.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "LinkTypeNumber":{
            "title":"Link Type Number",
            "maxLength":64,
            "type":"string",
            "description":"The type of link between the source and target objects.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectReference":{
            "title":"Object Reference",
            "type":"string",
            "description":"Reference value that can be used to query both SourceObjectReference and TargetObjectReference.",
            "nullable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "type":"string",
            "description":"Lookup code that indicates the type of the Object. This can be used to query both SourceObjectTypeCd and TargetObjectTypeCd.",
            "nullable":true
        },
        "SourceObjectId":{
            "title":"Source ID",
            "type":"integer",
            "description":"The identifier of the source object.",
            "nullable":true
        },
        "SourceObjectReference":{
            "title":"Source Reference",
            "maxLength":64,
            "type":"string",
            "description":"The reference value of the source object.",
            "nullable":false
        },
        "SourceObjectTypeCd":{
            "title":"Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the type of the source object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TargetObjectId":{
            "title":"Target ID",
            "type":"integer",
            "description":"The unique identifier of the target object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TargetObjectReference":{
            "title":"Target Reference",
            "maxLength":64,
            "type":"string",
            "description":"The reference value of the target object.",
            "nullable":false
        },
        "TargetObjectTypeCd":{
            "title":"Target Type",
            "maxLength":30,
            "type":"string",
            "description":"Lookup code that indicates the type of the target object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : objectLinks-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.
• 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

  Reference value that can be used to query both SourceObjectReference and TargetObjectReference.
• ObjectTypeCd: string
  Title: Object Type

  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.

{
    "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
        },
        "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,
            "readOnly":true,
            "x-queryable":true
        },
        "InwardCdMeaning":{
            "title":"Inward Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value of the inward lookup code for the link type used for the object link.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InwardCd"
                ]
            },
            "x-queryable":true
        },
        "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
        },
        "LinkId":{
            "title":"Link ID",
            "type":"integer",
            "description":"The object link identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkNumber":{
            "title":"Link Number",
            "maxLength":64,
            "type":"string",
            "description":"The reference number of the object link.",
            "nullable":false,
            "x-queryable":true
        },
        "LinkTypeNumber":{
            "title":"Link Type Number",
            "maxLength":64,
            "type":"string",
            "description":"The type of link between the source and target objects.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LinkTypeShortName":{
            "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
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"A descriptive name for the link type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectReference":{
            "title":"Object Reference",
            "type":"string",
            "description":"Reference value that can be used to query both SourceObjectReference and TargetObjectReference.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "type":"string",
            "description":"Lookup code that indicates the type of the Object. This can be used to query both SourceObjectTypeCd and TargetObjectTypeCd.",
            "nullable":true,
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "OutwardCdMeaning":{
            "title":"Outward Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value of the outward lookup code for the link type used for the object link.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "OutwardCd"
                ]
            },
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source ID",
            "type":"integer",
            "description":"The identifier of the source object.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectReference":{
            "title":"Source Reference",
            "maxLength":64,
            "type":"string",
            "description":"The reference value of the source object.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectTypeCd":{
            "title":"Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the type of the source object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceObjectTypeCdMeaning":{
            "title":"Source Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value of the source object type lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectTypeCd"
                ]
            },
            "x-queryable":true
        },
        "TargetObjectId":{
            "title":"Target ID",
            "type":"integer",
            "description":"The unique identifier of the target object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TargetObjectReference":{
            "title":"Target Reference",
            "maxLength":64,
            "type":"string",
            "description":"The reference value of the target object.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetObjectTypeCd":{
            "title":"Target Type",
            "maxLength":30,
            "type":"string",
            "description":"Lookup code that indicates the type of the target object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TargetObjectTypeCdMeaning":{
            "title":"Target Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value of the target object type lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TargetObjectTypeCd"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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."
        }
    }
}

Links

ObjectLinkTypeLOV

Operation: /crmRestApi/resources/11.13.18.05/objectLinkTypes

The following properties are defined on the LOV link relation:

• Source Attribute: LinkTypeNumber; Target Attribute: LinkTypeNumber
• Display Attribute: ShortName, Name, LinkTypeNumber

ObjectTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_LINK_OBJECT_CD

The following properties are defined on the LOV link relation:

• Source Attribute: TargetObjectTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top