Skip to main content
Skip table of contents

5.4 File Metadata

Pickup API sends files from all sources. In some cases the source can be identified from file name or file content. Otherwise, this service will identify the source organization.

This service is also useful if the flow needs to create the source organization on the fly on the target. Information includes Organization External (Public) code and Organization name.

Method

Request Url

GET

api/TransportMgr/FileMetadata/<FileCode>

Type

Parameter

Values

HEAD

Authorization

<TransportMgrAuthHeader>

URL_PARAM

Flow Code

Transport Code (TRN…)

Status

Response

Note

200


JAVA
{
File Code : <string>,
FileName : <string>,
FileSize : <long>
DateCreated : <datetime>
FileProcessingType : <int> FileProcessingTypeDisplay : <string>
FileStatus : <int>
FileStatusDisplay : <string>
RelatedFileCode : <string>
RelatedFileName : <string>
ParticipantCode : <string>
ParticipantExternalCode : <string>
ParticipantName : <string>
ParticipantType : <int>
ParticipantTypeDisplay : <string>
ParticipantEndpointCode : <string>
ParticipantEndpointName : <string>
Flow Code : <string>
FlowName : <string>
FlowTool : <int>
FlowToolDisplay : <string>
}


success

403

Content contains access denied message

Invalid Authorization Header in API call.
Flow Code parameter in Transport does not match the Flow Code in Authorization header

500

Content contains exception (message and stack trace)

Failed to find the flow, chunk upload failed, end of file processing failed

Parameter

Value

File Processing Type
File Processing Type Display

-1 : None
0 : All
1 : Flow
2 : Delivery

FileStatus
File Status Display

-1 : None
0 : All
1 : Pending
2 : InProgress
3 : Passed
4 : Failed
5 : MixedResult
6 : PartialDelivery
7 : Delivered
8 : NoDeliveryTargets
9 : ReplyRequest
10 : ReplyRequestFailed
11 : Quarantined

Flow Tool
Flow Tool Display

0 : All
1 : InHouse
2 : MuleSoft
4 : None
5 : Boomi

Participant Type
Participant Type Display

-1 : None
0 : All
1 : Internal
2 : Distributor
3 : Reseller
4 : Supplier
5 : Vendor
6 : Other
7 : Client
8 : Partner
9 : Wholesaler
10 : Subsidiary
11 : Manufacturer
12 : Business

Flow Code and other fields

Flow is a Transport in this structure

Participant Code

Participant is an Organization. Participant Code is Thru MFT assigned code

Participant External Code

External code is public code assigned by the enterprise (like DUNS number)

Relate File Code and Name

These fields are populated for drop-off files only and point to the source file.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.