Jump to

• Request
• Response

Upload a file

post

/fscmRestApi/resources/11.13.18.05/collaborationSupplyDataUploads

Request

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

• Attachment: string (byte)
  Value that identifies the base64-encoded supply data file.
• B2BFlag: boolean
  Contains one of the following values: true or false. If true, then the request originated from a business-to-business message. If false, then it didn't. The default value is false.
• B2BUser: string
  Maximum Length: 64

  User who created the B2B message.
• CollectionType: string
  Title: Collection Type

  Type of planning data collection process that can be launched.
• CollectionTypeCode: string
  Maximum Length: 32

  Abbreviation that identifies the type of planning data collection process that can be launched. Accepted values are 1 for Targeted and 2 for Net Change.
• DocumentId(required): integer (int64)
  Value that uniquely identifies the uploaded supply data file.
• Filename(required): string
  Title: File Name

  Maximum Length: 512

  Name of the uploaded supply data file.
• MessageId: string
  Maximum Length: 256

  Value that uniquely identifies the B2B message.
• Notes: string
  Title: Notes

  Maximum Length: 500

  Notes associated with the import request.
• SourceSystem(required): string
  Title: Source System

  Maximum Length: 30

  Alphanumeric code used to identify the source application.
• statusDetails: array Status Details
  Title: Status Details

  The Status Details resource gets the errors associated with a supply data upload request.
• SupplierId: integer (int64)
  Value that uniquely identifies the trading partner invoking the B2B message

{
    "required":[
        "DocumentId",
        "Filename",
        "SourceSystem"
    ],
    "type":"object",
    "properties":{
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner invoking the B2B message",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "B2BUser":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the B2B message.",
            "nullable":true
        },
        "CollectionType":{
            "title":"Collection Type",
            "type":"string",
            "description":"Type of planning data collection process that can be launched.",
            "nullable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the uploaded supply data file.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Filename":{
            "title":"File Name",
            "maxLength":"512",
            "type":"string",
            "description":"Name of the uploaded supply data file.",
            "nullable":false
        },
        "statusDetails":{
            "title":"Status Details",
            "type":"array",
            "description":"The Status Details resource gets the errors associated with a supply data upload request.",
            "items":{
                "$ref":"#/components/schemas/collaborationSupplyDataUploads-statusDetails-item-post-request"
            }
        },
        "Attachment":{
            "type":"string",
            "description":"Value that identifies the base64-encoded supply data file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":"30",
            "type":"string",
            "description":"Alphanumeric code used to identify the source application.",
            "nullable":false
        },
        "Notes":{
            "title":"Notes",
            "maxLength":"500",
            "type":"string",
            "description":"Notes associated with the import request.",
            "nullable":true
        },
        "CollectionTypeCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the type of planning data collection process that can be launched. Accepted values are 1 for Targeted and 2 for Net Change.",
            "nullable":true
        },
        "MessageId":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that uniquely identifies the B2B message.",
            "nullable":true
        },
        "B2BFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the request originated from a business-to-business message. If false, then it didn't. The default value is false.",
            "nullable":true
        }
    }
}

Nested Schema : Status Details

Type: array

Title: Status Details

The Status Details resource gets the errors associated with a supply data upload request.

Show Source

• Array of: object collaborationSupplyDataUploads-statusDetails-item-post-request

{
    "title":"Status Details",
    "type":"array",
    "description":"The Status Details resource gets the errors associated with a supply data upload request.",
    "items":{
        "$ref":"#/components/schemas/collaborationSupplyDataUploads-statusDetails-item-post-request"
    }
}

Nested Schema : collaborationSupplyDataUploads-statusDetails-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : collaborationSupplyDataUploads-item-response

Type: object

Show Source

• Attachment: string (byte)
  Value that identifies the base64-encoded supply data file.
• B2BFlag: boolean
  Contains one of the following values: true or false. If true, then the request originated from a business-to-business message. If false, then it didn't. The default value is false.
• B2BUser: string
  Maximum Length: 64

  User who created the B2B message.
• BOInErrorList: string
  Read Only: true

  Maximum Length: 404

  Comma-separated list of objects that weren't loaded to the staging tables.
• BOInWarningList: string
  Read Only: true

  Maximum Length: 404

  Comma-separated list of objects that encountered a warning when loaded to the staging tables.
• BOLoadErrorsFlag: boolean
  Title: Error Type

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then errors occurred when loading an object to the staging tables. If false, then errors didn't occur. The default value is false.
• BOLoadWarningsFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then warnings occurred when loading an object to the staging tables. If false, then warnings didn't occur. The default value is false.
• CollectionProcessId: integer (int64)
  Title: Collection Process ID

  Read Only: true

  Value that uniquely identifies the running Collection Job Set scheduled process.
• CollectionType: string
  Title: Collection Type

  Type of planning data collection process that can be launched.
• CollectionTypeCode: string
  Maximum Length: 32

  Abbreviation that identifies the type of planning data collection process that can be launched. Accepted values are 1 for Targeted and 2 for Net Change.
• CreatedBy: string
  Title: Submitted By

  Read Only: true

  Maximum Length: 64

  User who created the supply data request.
• CreationDate: string (date-time)
  Title: Last Uploaded

  Read Only: true

  Date and time when the user created the supply data request.
• DocumentId: integer (int64)
  Value that uniquely identifies the uploaded supply data file.
• Filename: string
  Title: File Name

  Maximum Length: 512

  Name of the uploaded supply data file.
• ImportRequestId: integer (int64)
  Title: Request ID

  Read Only: true

  Value that uniquely identifies the user's request to import data.
• LastUpdateDate: string (date-time)
  Title: Last Uploaded

  Read Only: true

  Date and time when the user most recently updated the supply data request.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the supply data request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageId: string
  Maximum Length: 256

  Value that uniquely identifies the B2B message.
• Notes: string
  Title: Notes

  Maximum Length: 500

  Notes associated with the import request.
• ProcessErrorsFlag: boolean
  Title: Error Type

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then errors occurred when processing the supply data request. If false, then errors didn't occur. The default value is false.
• ProcessId: integer (int64)
  Title: Process ID

  Read Only: true

  Value that uniquely identifies the running Load Supply Data for Externally Managed Organizations scheduled process.
• RefreshNumber: integer (int64)
  Read Only: true

  Number used by the Collection Job Set scheduled process to collect data.
• RequestSource: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of user who performed the request action. Values include Enterprise or Supplier.
• RequestSourceCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of user who performed the request action.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  Alphanumeric code used to identify the source application.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Current state of the import request.
• StatusCode: string
  Read Only: true

  Maximum Length: 32

  Abbreviation that identifies the current state of the import request.
• statusDetails: array Status Details
  Title: Status Details

  The Status Details resource gets the errors associated with a supply data upload request.
• SupplierId: integer (int64)
  Value that uniquely identifies the trading partner invoking the B2B message

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Last Uploaded",
            "type":"string",
            "description":"Date and time when the user created the supply data request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ImportRequestId":{
            "title":"Request ID",
            "type":"integer",
            "description":"Value that uniquely identifies the user's request to import data.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BOLoadWarningsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then warnings occurred when loading an object to the staging tables. If false, then warnings didn't occur. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "B2BUser":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the B2B message.",
            "nullable":true,
            "x-queryable":true
        },
        "BOInWarningList":{
            "maxLength":"404",
            "type":"string",
            "description":"Comma-separated list of objects that encountered a warning when loaded to the staging tables.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the uploaded supply data file.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Attachment":{
            "type":"string",
            "description":"Value that identifies the base64-encoded supply data file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CollectionProcessId":{
            "title":"Collection Process ID",
            "type":"integer",
            "description":"Value that uniquely identifies the running Collection Job Set scheduled process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the current state of the import request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollectionTypeCode":{
            "maxLength":"32",
            "type":"string",
            "description":"Abbreviation that identifies the type of planning data collection process that can be launched. Accepted values are 1 for Targeted and 2 for Net Change.",
            "nullable":true,
            "x-queryable":true
        },
        "BOLoadErrorsFlag":{
            "title":"Error Type",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then errors occurred when loading an object to the staging tables. If false, then errors didn't occur. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollectionType":{
            "title":"Collection Type",
            "type":"string",
            "description":"Type of planning data collection process that can be launched.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Notes":{
            "title":"Notes",
            "maxLength":"500",
            "type":"string",
            "description":"Notes associated with the import request.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Current state of the import request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestSourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of user who performed the request action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the supply data request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Submitted By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the supply data request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BOInErrorList":{
            "maxLength":"404",
            "type":"string",
            "description":"Comma-separated list of objects that weren't loaded to the staging tables.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Filename":{
            "title":"File Name",
            "maxLength":"512",
            "type":"string",
            "description":"Name of the uploaded supply data file.",
            "nullable":false,
            "x-queryable":true
        },
        "RefreshNumber":{
            "type":"integer",
            "description":"Number used by the Collection Job Set scheduled process to collect data.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestSource":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Type of user who performed the request action. Values include Enterprise or Supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessErrorsFlag":{
            "title":"Error Type",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then errors occurred when processing the supply data request. If false, then errors didn't occur. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "B2BFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the request originated from a business-to-business message. If false, then it didn't. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner invoking the B2B message",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "statusDetails":{
            "title":"Status Details",
            "type":"array",
            "description":"The Status Details resource gets the errors associated with a supply data upload request.",
            "items":{
                "$ref":"#/components/schemas/collaborationSupplyDataUploads-statusDetails-item-response"
            }
        },
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"Value that uniquely identifies the running Load Supply Data for Externally Managed Organizations scheduled process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":"30",
            "type":"string",
            "description":"Alphanumeric code used to identify the source application.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Uploaded",
            "type":"string",
            "description":"Date and time when the user most recently updated the supply data request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that uniquely identifies the B2B message.",
            "nullable":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 : Status Details

Type: array

Title: Status Details

The Status Details resource gets the errors associated with a supply data upload request.

Show Source

• Array of: object collaborationSupplyDataUploads-statusDetails-item-response

{
    "title":"Status Details",
    "type":"array",
    "description":"The Status Details resource gets the errors associated with a supply data upload request.",
    "items":{
        "$ref":"#/components/schemas/collaborationSupplyDataUploads-statusDetails-item-response"
    }
}

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 : collaborationSupplyDataUploads-statusDetails-item-response

Type: object

Show Source

• ItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Number that identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Title: Error Message

  Read Only: true

  Maximum Length: 2000

  Text of the message related to the import request.
• MessageType: string
  Read Only: true

  Maximum Length: 150

  Type of message in the import request. Values include ERROR_SEC and ERROR_REC. ERROR_SEC: For errors that occur when running the Load Supply Data for Externally Managed Organizations scheduled process. ERROR_REC: For errors that occur when running the Collection Job Set scheduled process.
• ObjectType: string
  Title: Object Type

  Read Only: true

  Maximum Length: 80

  Type of object in the import request.
• ObjectTypeCode: string
  Read Only: true

  Maximum Length: 29

  Abbreviation that identifies the type of object in the import request.
• OrderType: string
  Title: Order Type

  Read Only: true

  Maximum Length: 320

  Type of order for the object in the import request.
• OrderTypeCode: integer
  Read Only: true

  Abbreviation that identifies the type of order for the object in the import request.
• OrganizationCode: string
  Title: Organization

  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization that receives the item.
• SupplierName: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  Name of the supplier who ships the item.
• SupplierSiteName: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 30

  Name of the supplier site that ships the item.

{
    "type":"object",
    "properties":{
        "ObjectType":{
            "title":"Object Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type of object in the import request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the type of order for the object in the import request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderType":{
            "title":"Order Type",
            "maxLength":"320",
            "type":"string",
            "description":"Type of order for the object in the import request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Message":{
            "title":"Error Message",
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the message related to the import request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier who ships the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "maxLength":"29",
            "type":"string",
            "description":"Abbreviation that identifies the type of object in the import request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organization that receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupplierSiteName":{
            "title":"Supplier Site",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageType":{
            "maxLength":"150",
            "type":"string",
            "description":"Type of message in the import request. Values include ERROR_SEC and ERROR_REC. ERROR_SEC: For errors that occur when running the Load Supply Data for Externally Managed Organizations scheduled process. ERROR_REC: For errors that occur when running the Collection Job Set scheduled process.",
            "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

statusDetails

Operation: /fscmRestApi/resources/11.13.18.05/collaborationSupplyDataUploads/{ImportRequestId}/child/statusDetails

Parameters:

• ImportRequestId: $request.path.ImportRequestId

The Status Details resource gets the errors associated with a supply data upload request.

Back to Top