Jump to

• Request
• Response

Get one relationship

get

/fscmRestApi/resources/11.13.18.05/crossReferenceRelationships/{crossReferenceRelationshipsUniqID}

Request

Path Parameters

• crossReferenceRelationshipsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ItemRelationshipId, InventoryItemId and ApplicableOrganizationId ---for the Cross-Reference Relationships resource and used to uniquely identify an instance of Cross-Reference Relationships. The client should not generate the hash key value. Instead, the client should query on the Cross-Reference Relationships collection resource with a filter on the primary key values in order to navigate to a specific instance of Cross-Reference Relationships.
  
  For example: crossReferenceRelationships?q=ItemRelationshipId=<value1>;InventoryItemId=<value2>;ApplicableOrganizationId=<value3>

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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : crossReferenceRelationships-item-response

Type: object

Show Source

• ApplicableOrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization.
• ApplicableOrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• ApplyToAllOrganizationFlag: boolean
  Title: Organization Independent

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the cross-reference is applicable to all the organizations. If false, then it's not. The default value is true.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the cross-reference relationship.
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the user created the cross-reference relationship.
• CrossReference: string
  Title: Value

  Maximum Length: 255

  Value that identifies the cross-reference.
• CrossReferenceType: string
  Maximum Length: 80

  Type of the cross-reference. A list of accepted values is defined in the lookup type EGP_ITEM_XREF_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. There is no default value.
• DFF: array DFF
• InventoryItemId: integer
  Value that uniquely identifies an item.
• Item: string
  Maximum Length: 300

  Name or number of the part, item, product, or service.
• ItemRelationshipId: integer (int64)
  Value that uniquely identifies the cross-reference relationship.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date when the user most recently updated the cross-reference relationship.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the cross-reference relationship.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the cross-reference relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MasterOrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the master organization of the item for which the cross-reference relationship is defined.
• MasterOrganizationId: integer
  Value that uniquely identifies the master organization of the item for which the cross-reference relationship is defined.
• RelationshipDescription: string
  Title: Description

  Maximum Length: 240

  Description of the cross-reference relationship.
• translatableAttributes: array Translatable Attributes
  Title: Translatable Attributes

  The Translatable Attributes resource manages the translatable attributes for item relationships.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the cross-reference relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the master organization of the item for which the cross-reference relationship is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the cross-reference relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date when the user most recently updated the cross-reference relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/crossReferenceRelationships-DFF-item-response"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item.",
            "nullable":false,
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name or number of the part, item, product, or service.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the cross-reference relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the master organization of the item for which the cross-reference relationship is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "CrossReferenceType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of the cross-reference. A list of accepted values is defined in the lookup type EGP_ITEM_XREF_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. There is no default value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cross-reference relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "translatableAttributes":{
            "title":"Translatable Attributes",
            "type":"array",
            "description":"The Translatable Attributes resource manages the translatable attributes for item relationships.",
            "items":{
                "$ref":"#/components/schemas/crossReferenceRelationships-translatableAttributes-item-response"
            }
        },
        "ApplyToAllOrganizationFlag":{
            "title":"Organization Independent",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the cross-reference is applicable to all the organizations. If false, then it's not. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "CrossReference":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the cross-reference.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the cross-reference relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ApplicableOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the cross-reference relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicableOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object crossReferenceRelationships-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/crossReferenceRelationships-DFF-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 : Translatable Attributes

Type: array

Title: Translatable Attributes

The Translatable Attributes resource manages the translatable attributes for item relationships.

Show Source

• Array of: object crossReferenceRelationships-translatableAttributes-item-response

{
    "title":"Translatable Attributes",
    "type":"array",
    "description":"The Translatable Attributes resource manages the translatable attributes for item relationships.",
    "items":{
        "$ref":"#/components/schemas/crossReferenceRelationships-translatableAttributes-item-response"
    }
}

Nested Schema : crossReferenceRelationships-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context
• ItemRelationshipId: integer (int64)
• ItemRelationshipType: string
  Title: Type

  Maximum Length: 30
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRelationshipType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "ItemRelationshipId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Nested Schema : crossReferenceRelationships-translatableAttributes-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who first provided value for the item relationship translatable attribute.
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the user first provided value for the item relationship translatable attribute.
• ItemRelationshipId: integer
  Value that uniquely identifies the item relationship.
• Language: string
  Maximum Length: 4

  Value that identifies the language used for the item relationship translatable attribute.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the item relationship translatable attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the item relationship translatable attribute.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the item relationship translatable attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelationshipDescription: string
  Maximum Length: 240

  Description of the item relationship.
• SourceLanguage: string
  Maximum Length: 4

  Source language of the translation.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item relationship translatable attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of the translation.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user first provided value for the item relationship translatable attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who first provided value for the item relationship translatable attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the item relationship translatable attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Value that identifies the language used for the item relationship translatable attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the item relationship translatable attribute.",
            "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"
    }
}

Links

CrossReferenceTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DEGP_ITEM_XREF_TYPES

The following properties are defined on the LOV link relation:

• Source Attribute: CrossReferenceType; Target Attribute: Meaning
• Display Attribute: Meaning, LookupCode

DFF

Operation: /fscmRestApi/resources/11.13.18.05/crossReferenceRelationships/{crossReferenceRelationshipsUniqID}/child/DFF

Parameters:

• crossReferenceRelationshipsUniqID: $request.path.crossReferenceRelationshipsUniqID

translatableAttributes

Operation: /fscmRestApi/resources/11.13.18.05/crossReferenceRelationships/{crossReferenceRelationshipsUniqID}/child/translatableAttributes

Parameters:

• crossReferenceRelationshipsUniqID: $request.path.crossReferenceRelationshipsUniqID

The Translatable Attributes resource manages the translatable attributes for item relationships.

Back to Top