API is used to upload new data file or release notes with the newly created data signedUrl or releaseNote signedUrl. You can upload or update both data file and release notes with same API one after the other with the respective uploads fields.
Within the API response of File Upload (step 1) /fileuploadstep1 or file update /fileUpdate, locate the uploads object. This object typically holds the information related to file uploads, including the signedUrl and associated fields.
Based on the type of data being uploaded (new data file or release notes), determine whether the "uploads" object contains a data or releaseNote object.
Within the relevant object ("data" or "releaseNote"), locate the property that holds the signedUrl. The signedUrl is a unique URL that grants authorization to upload the specified file.
Along with the signedUrl, the "data" or "releaseNote" object may contain additional fields required for the file upload process. These fields may include metadata about the file, authentication credentials, or upload parameters.
Once you have extracted the signedUrl and associated fields, organize them into a structured format that is compatible with the file upload API.
Here's an example of how to extract the signedUrl and associated fields from a API response:
{
"uploads": {
"data": {
"signedUrl": {
"url": "https://dmctc-prd-file-upload.s3-accelerate.amazonaws.com",
"fields": {
"key": "e7e32061-d7f7-4d5f-9d27-d65e873956d4.dat",
"bucket": "dmctc-prd-file-upload",
"X-Amz-Algorithm": "AWS4-HMAC-SHA256",
"X-Amz-Credential": "AKIAIA7564QNMGPPEKXA/20231106/us-east-1/s3/aws4_request",
"X-Amz-Date": "20231106T114253Z",
"Policy": "eyJleHBpcmF0aW9uIjoiMjAyMy0xMS0wN1QxMTo0Mjo1M1oiLCJjb25kaXRpb25zIjpbeyJrZXkiOiJlN2UzMjA2MS1kN2Y3LTRkNWYtOWQyNy1kNjVlODczOTU2ZDQuZGF0In0seyJidWNrZXQiOiJkbWN0Yy1xYTEtZmlsZS11cGxvYWQifSx7IlgtQW16LUFsZ29yaXRobSI6IkFXUzQtSE1BQy1TSEEyNTYifSx7IlgtQW16LUNyZWRlbnRpYWwiOiJBS0lBSUE3NTY0UU5NR1BQRUtYQS8yMDIzMTEwNi91cy1lYXN0LTEvczMvYXdzNF9yZXF1ZXN0In0seyJYLUFtei1EYXRlIjoiMjAyMzExMDZUMTE0MjUzWiJ9XX0=",
"X-Amz-Signature": "82a2c19fbf906a6b399053c79ea2801b8d45b20602794251febfe8415cdc3a98"
}
},
"paramsData": {
"Bucket": "dmctc-prd-file-upload",
"Fields": {
"key": "e7e32061-d7f7-4d5f-9d27-d65e873956d4.dat"
},
"Expires": 86400
}
},
"releaseNote": {
"signedUrl": {
"url": "https://dmctc-prd-file-upload.s3-accelerate.amazonaws.com",
"fields": {
"key": "e7e32061-d7f7-4d5f-9d27-d65e873956d4.notes",
"bucket": "dmctc-prd-file-upload",
"X-Amz-Algorithm": "AWS4-HMAC-SHA256",
"X-Amz-Credential": "AKIAIA7564QNMGPPEKXA/20231106/us-east-1/s3/aws4_request",
"X-Amz-Date": "20231106T114253Z",
"Policy": "eyJleHBpcmF0aW9uIjoiMjAyMy0xMS0wN1QxMTo0Mjo1M1oiLCJjb25kaXRpb25zIjpbeyJrZXkiOiJlN2UzMjA2MS1kN2Y3LTRkNWYtOWQyNy1kNjVlODczOTU2ZDQubm90ZXMifSx7ImJ1Y2tldCI6ImRtY3RjLXFhMS1maWxlLXVwbG9hZCJ9LHsiWC1BbXotQWxnb3JpdGhtIjoiQVdTNC1ITUFDLVNIQTI1NiJ9LHsiWC1BbXotQ3JlZGVudGlhbCI6IkFLSUFJQTc1NjRRTk1HUFBFS1hBLzIwMjMxMTA2L3VzLWVhc3QtMS9zMy9hd3M0X3JlcXVlc3QifSx7IlgtQW16LURhdGUiOiIyMDIzMTEwNlQxMTQyNTNaIn1dfQ==",
"X-Amz-Signature": "04c6185307afec4c9fa6c3c3679b2992dea1e1a75342b15c2f9bdfc59203a9c9"
}
},
"paramsData": {
"Bucket": "dmctc-prd-file-upload",
"Fields": {
"key": "e7e32061-d7f7-4d5f-9d27-d65e873956d4.notes"
},
"Expires": 86400
}
}
}
}
By following these steps, you can effectively extract the signedUrl and associated fields from the API response and utilize them for file upload purposes.
To retrieve file metadata or download a file after successful upload or update, you can make a GET request to /files/{fileId} (FileMeta).