Jump to

• Request
• Response
• Examples

Create relationships

post

/fscmRestApi/resources/11.13.18.05/crossReferenceRelationships

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApplicableOrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization.
• ApplicableOrganizationId(required): 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.
• CrossReference(required): string
  Title: Value

  Maximum Length: 255

  Value that identifies the cross-reference.
• crossReferenceDFF: array crossReferenceDFF
• 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(required): 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.
• 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.

{
    "required":[
        "ApplicableOrganizationId",
        "CrossReference",
        "InventoryItemId"
    ],
    "type":"object",
    "properties":{
        "ApplicableOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ApplicableOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "CrossReference":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the cross-reference.",
            "nullable":false
        },
        "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"
            }
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/crossReferenceRelationships-DFF-item-post-request"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item.",
            "nullable":false
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name or number of the part, item, product, or service.",
            "nullable":true
        },
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cross-reference relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "MasterOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the master organization of the item for which the cross-reference relationship is defined.",
            "nullable":true
        },
        "RelationshipDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the cross-reference relationship.",
            "nullable":true
        },
        "crossReferenceDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/crossReferenceRelationships-crossReferenceDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "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-post-request"
            }
        }
    }
}

Nested Schema : crossReferenceDFF

Type: array

Show Source

• Array of: object crossReferenceRelationships-crossReferenceDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/crossReferenceRelationships-crossReferenceDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/crossReferenceRelationships-DFF-item-post-request"
    }
}

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-post-request

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

Nested Schema : crossReferenceRelationships-crossReferenceDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 150

  Context
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context
• ItemRelationshipId: integer (int64)
• ItemRelationshipType: string
  Title: Type

  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "ItemRelationshipId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "ItemRelationshipType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":150,
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context"
                },
                "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"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 150

  Context
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context
• ItemRelationshipId: integer (int64)
• ItemRelationshipType: string
  Title: Type

  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "ItemRelationshipId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "ItemRelationshipType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":150,
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context"
                },
                "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"
                }
            }
        }
    }
}

Nested Schema : crossReferenceRelationships-translatableAttributes-item-post-request

Type: object

Show Source

• 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.
• RelationshipDescription: string
  Maximum Length: 240

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

  Source language of the translation.

{
    "type":"object",
    "properties":{
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item relationship.",
            "nullable":false
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Value that identifies the language used for the item relationship translatable attribute.",
            "nullable":false
        },
        "RelationshipDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item relationship.",
            "nullable":true
        },
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of the translation.",
            "nullable":false
        }
    }
}

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 : 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.
• crossReferenceDFF: array crossReferenceDFF
• 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":{
        "ApplicableOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ApplicableOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the cross-reference relationship.",
            "nullable":false,
            "readOnly":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
        },
        "CrossReference":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the cross-reference.",
            "nullable":false,
            "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
        },
        "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
        },
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cross-reference relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the cross-reference relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "RelationshipDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the cross-reference relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "crossReferenceDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/crossReferenceRelationships-crossReferenceDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
            }
        }
    }
}

Nested Schema : crossReferenceDFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/crossReferenceRelationships-crossReferenceDFF-item-response"
    },
    "x-cardinality":"1"
}

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-crossReferenceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 150

  Context
• __FLEX_Context_DisplayValue: string
  Title: Context

  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":{
        "ItemRelationshipId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ItemRelationshipType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":150,
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context"
                },
                "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
        },
        "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."
        }
    }
}

Nested Schema : crossReferenceRelationships-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 150

  Context
• __FLEX_Context_DisplayValue: string
  Title: Context

  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":{
        "ItemRelationshipId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ItemRelationshipType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":150,
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Context",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context"
                },
                "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
        },
        "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 : 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":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who first provided value for the item relationship translatable attribute.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item relationship.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item relationship translatable attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of the translation.",
            "nullable":false,
            "x-queryable":true
        },
        "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"
    }
}

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

crossReferenceDFF

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

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

Examples

This example describes how to create relationships.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/crossReferenceRelationships"

Example 1 Request Body

The following example includes the contents of the request body in JSON format to create a cross reference relationship applicable to all organizations. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"MasterOrganizationCode" : "V1",
	"Item" : "ABC",
	"CrossReferenceType" : "Old Part Number",
	"CrossReference" : "123",
	"ApplyToAllOrganizationFlag" : true,
	"RelationshipDescription" : "Legacy Part number"
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
	"ItemRelationshipId": 300100197102447,
	"MasterOrganizationId": 204,
	"MasterOrganizationCode": "V1",
	"InventoryItemId": 300100185399391,
	"Item": "ABC",
	"CrossReferenceType": "Old Part Number",
	"CrossReference": "123",
	"ApplyToAllOrganizationFlag": true,
	"ApplicableOrganizationId": null,
	"ApplicableOrganizationCode": null,
	"RelationshipDescription": "Legacy Part number",
	"CreationDateTime": "2020-07-10T10:43:51.023+00:00",
	"LastUpdateDateTime": "2020-07-10T10:43:51.301+00:00",
	"CreatedBy": "user",
	"LastUpdateLogin": "A9EBC4B5D3EA1384E0537AA8F00AF719",
	"LastUpdatedBy": "user",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5336F0000000EACED00057708000110F084F2A05FFFFFFFFF",
		"name": "crossReferenceRelationships",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://xxx.oracle.com/fscmRestApi/resources/11.13.18.05/crossReferenceRelationships/00030000000EACED00057708000110F085A5336F0000000EACED00057708000110F084F2A05FFFFFFFFF",
		"name": "crossReferenceRelationships",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://xxx.oracle.com/fscmRestApi/resources/11.13.18.05/crossReferenceRelationships/00030000000EACED00057708000110F085A5336F0000000EACED00057708000110F084F2A05FFFFFFFFF/child/DFF",
		"name": "DFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://xxx.oracle.com/fscmRestApi/resources/11.13.18.05/crossReferenceRelationships/00030000000EACED00057708000110F085A5336F0000000EACED00057708000110F084F2A05FFFFFFFFF/child/translatableAttributes",
		"name": "translatableAttributes",
		"kind": "collection"
	}
	]
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format to create a cross reference relationship with DFF values. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"MasterOrganizationCode" : "V1",
	"Item" : "DemoItemJul10_1",
	"CrossReferenceType" : "Charge Master",
	"CrossReference" : "DemoXrefM1Jul10_1",
	"ApplyToAllOrganizationFlag" : false,
	"ApplicableOrganizationCode" : "M1",
	"RelationshipDescription" : "Test Item Xref",
	"DFF" : [

	{
		"char1" : "postXref1",
		"char2" : "Delhi"
	}

	]
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
	"ItemRelationshipId": 300100197102399,
	"MasterOrganizationId": 204,
	"MasterOrganizationCode": "V1",
	"InventoryItemId": 300100185399391,
	"Item": "DemoItemJul10_1",
	"CrossReferenceType": "Charge Master",
	"CrossReference": "DemoXrefM1Jul10_1",
	"ApplyToAllOrganizationFlag": false,
	"ApplicableOrganizationId": 207,
	"ApplicableOrganizationCode": "M1",
	"RelationshipDescription": "Test Item Xref",
	"CreationDateTime": "2020-07-10T10:41:50.001+00:00",
	"LastUpdateDateTime": "2020-07-10T10:41:51.336+00:00",
	"CreatedBy": "user",
	"LastUpdateLogin": "A9EBC4B5D3EA1384E0537AA8F00AF719",
	"LastUpdatedBy": "user",
	"DFF": [
	{
		"ItemRelationshipId": 300100197102399,
		"ItemRelationshipType": "ITEM_XREF",
		"char1": "postXref1",
		"numb1": null,
		"date1": null,
		"datetime1": null,
		"char2": "Delhi",
		"RELGlobSegChar1": null,
		"zbiaitemreldff": null,
		"__FLEX_Context": null,
		"__FLEX_Context_DisplayValue": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5333F0000000EACED00057708000110F084F2A05F0000000EACED0005770800000000000000CF/child/DFF/300100197102399",
			"name": "DFF",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5333F0000000EACED00057708000110F084F2A05F0000000EACED0005770800000000000000CF/child/DFF/300100197102399",
			"name": "DFF",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5333F0000000EACED00057708000110F084F2A05F0000000EACED0005770800000000000000CF",
			"name": "crossReferenceRelationships",
			"kind": "item"
		}
		]
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5333F0000000EACED00057708000110F084F2A05F0000000EACED0005770800000000000000CF",
		"name": "crossReferenceRelationships",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5333F0000000EACED00057708000110F084F2A05F0000000EACED0005770800000000000000CF",
		"name": "crossReferenceRelationships",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5333F0000000EACED00057708000110F084F2A05F0000000EACED0005770800000000000000CF/child/DFF",
		"name": "DFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5333F0000000EACED00057708000110F084F2A05F0000000EACED0005770800000000000000CF/child/translatableAttributes",
		"name": "translatableAttributes",
		"kind": "collection"
	}
	]
}

Back to Top