Jump to

• Request
• Response

Create a translation

post

/fscmRestApi/resources/11.13.18.05/supplierProducts/{supplierProductsUniqID}/child/translations

Request

Path Parameters

• supplierProductsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Products resource and used to uniquely identify an instance of Supplier Products. The client should not generate the hash key value. Instead, the client should query on the Supplier Products collection resource in order to navigate to a specific instance of Supplier Products to get the hash key.

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.
• Upsert-Mode:
  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

• HTMLLongDescription: string
  Maximum Length: 2147483647

  Text description of the part, item, product, or service that includes hypertext tags.
• InterfaceTableUniqueId: integer (int64)
  Value that uniquely identifies the translation row in staging.
• ItemDescription: string
  Maximum Length: 240

  Description of the part, item, product, or service.
• ItemNumber: string
  Maximum Length: 700

  Name or number of the part, item, product, or service.
• Language: string
  Maximum Length: 4

  Language associated with the item record.
• LongDescription: string
  Maximum Length: 4000

  Text description of the part, item, product, or service.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• ProductNumber: string
  Maximum Length: 255

  Name or number of the spoke part, item, product, or service.
• SourceLanguage: string
  Maximum Length: 4

  Source language associated with the item record.
• SpokeSystemCode: string
  Maximum Length: 30

  Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• SpokeSystemId: integer (int64)
  Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• SupplierName: string
  Title: Supplier

  Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• TransactionId: integer (int64)
  Value that identifies the product row in staging.

{
    "type":"object",
    "properties":{
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Source language associated with the item record.",
            "nullable":true
        },
        "SpokeSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Name or number of the spoke part, item, product, or service.",
            "nullable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the part, item, product, or service.",
            "nullable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that identifies the product row in staging.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InterfaceTableUniqueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the translation row in staging.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ItemNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Name or number of the part, item, product, or service.",
            "nullable":true
        },
        "LongDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Text description of the part, item, product, or service.",
            "nullable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with the item record.",
            "nullable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "type":"string",
            "description":"Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "nullable":true
        },
        "HTMLLongDescription":{
            "maxLength":2147483647,
            "type":"string",
            "description":"Text description of the part, item, product, or service that includes hypertext tags.",
            "nullable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "nullable":true
        },
        "SpokeSystemCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "nullable":true
        }
    }
}

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 : supplierProducts-translations-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the application created the translation.
• HTMLLongDescription: string
  Maximum Length: 2147483647

  Text description of the part, item, product, or service that includes hypertext tags.
• InterfaceTableUniqueId: integer (int64)
  Value that uniquely identifies the translation row in staging.
• ItemDescription: string
  Maximum Length: 240

  Description of the part, item, product, or service.
• ItemNumber: string
  Maximum Length: 700

  Name or number of the part, item, product, or service.
• Language: string
  Maximum Length: 4

  Language associated with the item record.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the translation was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the translation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string
  Maximum Length: 4000

  Text description of the part, item, product, or service.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• ProductNumber: string
  Maximum Length: 255

  Name or number of the spoke part, item, product, or service.
• SourceLanguage: string
  Maximum Length: 4

  Source language associated with the item record.
• SpokeSystemCode: string
  Maximum Length: 30

  Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• SpokeSystemId: integer (int64)
  Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• SupplierName: string
  Title: Supplier

  Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• TransactionId: integer (int64)
  Value that identifies the product row in staging.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Source language associated with the item record.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the application created the translation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SpokeSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Name or number of the spoke part, item, product, or service.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the part, item, product, or service.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that identifies the product row in staging.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InterfaceTableUniqueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the translation row in staging.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Name or number of the part, item, product, or service.",
            "nullable":true,
            "x-queryable":true
        },
        "LongDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Text description of the part, item, product, or service.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with the item record.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "type":"string",
            "description":"Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "nullable":true,
            "x-queryable":true
        },
        "HTMLLongDescription":{
            "maxLength":2147483647,
            "type":"string",
            "description":"Text description of the part, item, product, or service that includes hypertext tags.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "nullable":true,
            "x-queryable":true
        },
        "SpokeSystemCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the translation was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "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