Jump to

• Request
• Response

Update linked MPN relationship

patch

/fscmRestApi/resources/11.13.18.05/tradingPartnerItemRelationships/{ItemRelationshipId}/child/LinkedMPNRelationships/{TPILinkageId}

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=
• TPILinkageId(required): integer(int64)
  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

• PrimaryLinkageFlag: boolean
  Maximum Length: 1

  Default Value: false

  Value that identifies whether the linked MPN relationship is primary. The default value is False.

{
    "type":"object",
    "properties":{
        "PrimaryLinkageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that identifies whether the linked MPN relationship is primary. The default value is False.",
            "nullable":false,
            "default":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(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 : tradingPartnerItemRelationships-LinkedMPNRelationships-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the linked MPN relationship.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the linked MPN relationship.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the linked MPN relationship.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the linked MPN relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturerId: integer
  Value that uniquely identifies the linked manufacturer.
• ManufacturerName: string
  Maximum Length: 255

  Name of the linked manufacturer.
• ManufacturerPartId: integer
  Value that uniquely identifies the manufacturer trading partner item.
• ManufacturerPartNumber: string
  Maximum Length: 255

  Number that identifies a manufacturer part number.
• ManufacturerRegistryId: string
  Maximum Length: 255

  Value that uniquely identifies the manufacturer party.
• PrimaryLinkageFlag: boolean
  Maximum Length: 1

  Default Value: false

  Value that identifies whether the linked MPN relationship is primary. The default value is False.
• RelationshipId: integer (int64)
  Value that uniquely identifies the linked MPN relationship.
• RelationshipStatus: string
  Read Only: true

  Maximum Length: 255

  Status of the linked MPN relationship.
• TPILinkageId: integer (int64)
  Value that uniquely identify MPN relationship linkage.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the linked MPN relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLinkageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that identifies whether the linked MPN relationship is primary. The default value is False.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the linked MPN relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the linked MPN relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManufacturerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the linked manufacturer.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturerRegistryId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the manufacturer party.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the linked manufacturer.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies a manufacturer part number.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the linked MPN relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the linked MPN relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TPILinkageId":{
            "type":"integer",
            "description":"Value that uniquely identify MPN relationship linkage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ManufacturerPartId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manufacturer trading partner item.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the linked MPN 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 linked MPN relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top