Jump to

• Request
• Response

Update a relationship

patch

/fscmRestApi/resources/11.13.18.05/relatedItemRelationships/{ItemRelationshipId}

Request

Path Parameters

• ItemRelationshipId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DFF: array DFF
• EndDateTime: string (date-time)
  Title: End Date

  Date when the related item relationship becomes ineffective.
• MasterControlledFlag: boolean
  Title: Controlled At

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the relationship is master controlled. If false, the relationship is organization controlled. The default value is true.
• PlanningEnabledFlag: boolean
  Title: Planning Enabled

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then planning is enabled for the relationship. If false, planning isn't enabled. The default value is false.
• Rank: integer (int64)
  Title: Rank

  Rank of the related item relationship.
• ReciprocalFlag: boolean
  Title: Reciprocal

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the relationship is mutual. If false, the relationship isn't mutual. The default value is false.
• RelationshipDescription: string
  Maximum Length: 240

  Description of the related item relationship.
• RelationshipType: string
  Maximum Length: 255

  Type of the related item relationship. A list of accepted values is defined in the lookup type EGP_RELATIONSHIP_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Null.
• StartDateTime: string (date-time)
  Date when the related item relationship becomes effective.
• translatableAttributes: array Translatable Attributes
  Title: Translatable Attributes

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

{
    "type":"object",
    "properties":{
        "MasterControlledFlag":{
            "title":"Controlled At",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the relationship is master controlled. If false, the relationship is organization controlled. The default value is true.",
            "nullable":true,
            "default":true
        },
        "StartDateTime":{
            "type":"string",
            "description":"Date when the related item relationship becomes effective.",
            "format":"date-time",
            "nullable":false
        },
        "EndDateTime":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the related item relationship becomes ineffective.",
            "format":"date-time",
            "nullable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/relatedItemRelationships-DFF-item-patch-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/relatedItemRelationships-translatableAttributes-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "RelationshipType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of the related item relationship. A list of accepted values is defined in the lookup type EGP_RELATIONSHIP_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Null.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the related item relationship.",
            "nullable":true
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"Rank of the related item relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReciprocalFlag":{
            "title":"Reciprocal",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the relationship is mutual. If false, the relationship isn't mutual. The default value is false.",
            "nullable":true
        },
        "PlanningEnabledFlag":{
            "title":"Planning Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then planning is enabled for the relationship. If false, planning isn't enabled. The default value is false.",
            "nullable":true
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object relatedItemRelationships-DFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/relatedItemRelationships-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

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 relatedItemRelationships-translatableAttributes-item-patch-request

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

Nested Schema : relatedItemRelationships-DFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context

{
    "type":"object",
    "properties":{
        "__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"
                }
            }
        },
        "__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_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"
                }
            }
        }
    }
}

Nested Schema : relatedItemRelationships-translatableAttributes-item-patch-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":{
        "SourceLanguage":{
            "maxLength":"4",
            "type":"string",
            "description":"Source language of the translation.",
            "nullable":false
        },
        "RelationshipDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item relationship.",
            "nullable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Value that identifies the language used for the item relationship translatable attribute.",
            "nullable":false
        },
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item relationship.",
            "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 : relatedItemRelationships-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the related item relationship.
• DFF: array DFF
• EndDateTime: string (date-time)
  Title: End Date

  Date when the related item relationship becomes ineffective.
• FromInventoryItemId: integer
  Value that uniquely identifies the from item in the related item relationship.
• FromItem: string
  Maximum Length: 255

  Value that identifies the from item in the related item relationship.
• FromItemApprovalStatus: string
  Read Only: true

  Maximum Length: 255

  Approval status of the from item in the related item relationship.
• FromItemClass: string
  Read Only: true

  Maximum Length: 255

  Item class of the from item in the related item relationship.
• FromItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the from item in the related item relationship.
• FromItemLifecyclePhase: string
  Read Only: true

  Maximum Length: 255

  Lifecycle phase of the from item in the related item relationship.
• FromItemPrimaryUOM: string
  Read Only: true

  Maximum Length: 255

  Primary unit of measure of the from item in the related item relationship.
• FromItemStatus: string
  Read Only: true

  Maximum Length: 255

  Status of the from item in the related item relationship.
• ItemRelationshipId: integer (int64)
  Value that uniquely identifies the related item relationship.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date when the user most recently updated the related item relationship.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MasterControlledFlag: boolean
  Title: Controlled At

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the relationship is master controlled. If false, the relationship is organization controlled. The default value is true.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization.
• OrganizationId: integer
  Value that uniquely identifies the organization.
• PlanningEnabledFlag: boolean
  Title: Planning Enabled

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then planning is enabled for the relationship. If false, planning isn't enabled. The default value is false.
• Rank: integer (int64)
  Title: Rank

  Rank of the related item relationship.
• ReciprocalFlag: boolean
  Title: Reciprocal

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the relationship is mutual. If false, the relationship isn't mutual. The default value is false.
• RelationshipDescription: string
  Maximum Length: 240

  Description of the related item relationship.
• RelationshipType: string
  Maximum Length: 255

  Type of the related item relationship. A list of accepted values is defined in the lookup type EGP_RELATIONSHIP_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Null.
• StartDateTime: string (date-time)
  Date when the related item relationship becomes effective.
• ToInventoryItemId: integer
  Value that uniquely identifies the to item in the related item relationship.
• ToItem: string
  Maximum Length: 255

  Value that identifies the to item in the related item relationship.
• ToItemApprovalStatus: string
  Read Only: true

  Maximum Length: 255

  Approval status of the to item in the related item relationship.
• ToItemClass: string
  Read Only: true

  Maximum Length: 255

  Item class of the to item in the related item relationship.
• ToItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the to item in the related item relationship.
• ToItemLifecyclePhase: string
  Read Only: true

  Maximum Length: 255

  Lifecycle phase of the to item in the related item relationship.
• ToItemPrimaryUOM: string
  Read Only: true

  Maximum Length: 255

  Primary unit of measure of the to item in the related item relationship.
• ToItemStatus: string
  Read Only: true

  Maximum Length: 255

  Status of the to item in the related item relationship.
• translatableAttributes: array Translatable Attributes
  Title: Translatable Attributes

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

{
    "type":"object",
    "properties":{
        "ToItemApprovalStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Approval status of the to item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date when the user most recently updated the related item relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/relatedItemRelationships-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "RelationshipType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of the related item relationship. A list of accepted values is defined in the lookup type EGP_RELATIONSHIP_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Null.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "nullable":false,
            "x-queryable":true
        },
        "ToItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the to item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromItemPrimaryUOM":{
            "maxLength":"255",
            "type":"string",
            "description":"Primary unit of measure of the from item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateTime":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the related item relationship becomes ineffective.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ToItemStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Status of the to item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromItem":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the from item in the related item relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ToItem":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the to item in the related item relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FromItemClass":{
            "maxLength":"255",
            "type":"string",
            "description":"Item class of the from item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the related 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"
            }
        },
        "ReciprocalFlag":{
            "title":"Reciprocal",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the relationship is mutual. If false, the relationship isn't mutual. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningEnabledFlag":{
            "title":"Planning Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then planning is enabled for the relationship. If false, planning isn't enabled. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ToItemLifecyclePhase":{
            "maxLength":"255",
            "type":"string",
            "description":"Lifecycle phase of the to item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromItemApprovalStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Approval status of the from item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromItemLifecyclePhase":{
            "maxLength":"255",
            "type":"string",
            "description":"Lifecycle phase of the from item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the related item relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the related item relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FromItemStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Status of the from item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToInventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the to item in the related item relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"Rank of the related item relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FromItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the from item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToItemClass":{
            "maxLength":"255",
            "type":"string",
            "description":"Item class of the to item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterControlledFlag":{
            "title":"Controlled At",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the relationship is master controlled. If false, the relationship is organization controlled. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the related item relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateTime":{
            "type":"string",
            "description":"Date when the related item relationship becomes effective.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the related item 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/relatedItemRelationships-translatableAttributes-item-response"
            },
            "x-cardinality":"1"
        },
        "ToItemPrimaryUOM":{
            "maxLength":"255",
            "type":"string",
            "description":"Primary unit of measure of the to item in the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromInventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the from item in the related item relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the related item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

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

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

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 relatedItemRelationships-translatableAttributes-item-response

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

Nested Schema : relatedItemRelationships-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_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
        }
    }
}

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

DFF

Operation: /fscmRestApi/resources/11.13.18.05/relatedItemRelationships/{ItemRelationshipId}/child/DFF

Parameters:

• ItemRelationshipId: $request.path.ItemRelationshipId

RelationshipTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DEGP_RELATIONSHIP_TYPES

The following properties are defined on the LOV link relation:

• Source Attribute: RelationshipType; Target Attribute: Meaning
• Display Attribute: Meaning

translatableAttributes

Operation: /fscmRestApi/resources/11.13.18.05/relatedItemRelationships/{ItemRelationshipId}/child/translatableAttributes

Parameters:

• ItemRelationshipId: $request.path.ItemRelationshipId

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

Back to Top