Skip to content

Retrieve Assignment Upload Instances by Assignment ID

Request

Fetches a list of upload instances related to the provided assignment ID. A valid authorization token is required for the request.

Security
Bearer
Query
assignmentIdinteger, (int32)required

The unique identifier for the assignment

curl -i -X GET \
  'https://developer.sustainabilitymaster.ai/_mock/openapi/api/DataCollection/AssignmentUploadSchedule?assignmentId=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved the assignment upload instances for the specified assignment ID.

Bodyapplication/json
Array [
idinteger, (int32)

The unique identifier for the collection data upload record.

Example:123
fileNamestring or null

The name of the file that was uploaded.

Example:"\"Assignment_Data_2025.xlsx\""
uploadedFileUrlstring or null

The URL where the uploaded file can be accessed.

Example:"\"https://example.com/uploads/Assignment_Data_2025.xlsx\""
scheduledDatestring, (date-time)

The scheduled date for the collection or task related to this upload.

Example:"\"2025-03-01T10:30:00\""
uploadedOnstring or null, (date-time)

The date and time when the file was uploaded.

Example:"\"2025-02-24T08:00:00\""
dueDatestring or null, (date-time)

The date by which the file upload is due.

Example:"\"2025-03-01T17:00:00\""
uploadedByUidstring or null

The unique identifier of the user who uploaded the file.

Example:"\"user123\""
uploadedByDisplayNamestring or null

The display name of the user who uploaded the file.

Example:"\"John Doe\""
statusinteger or null, (int32)

The status of the file upload (e.g., pending, completed, failed).

Example:1
reviewerUidstring or null

The unique identifier of the reviewer assigned to review the uploaded file.

Example:"\"reviewer456\""
reviewerNamestring or null

The name of the reviewer assigned to review the uploaded file.

Example:"\"Jane Smith\""
reviewerEmailstring or null

The email address of the reviewer assigned to review the uploaded file.

Example:"\"jane.smith@example.com\""
approvalStatusstring or null

The approval status of the uploaded file (e.g., approved, rejected).

Example:"\"approved\""
commentsstring or null

Any comments provided during the file upload or review process.

Example:"\"File looks good and ready for review.\""
archivedboolean or null

Flag indicating whether the upload has been archived.

Example:false
uploadProofsArray of objects or null(TopicFileUploadProofReqRes)

List of topic file upload proof requests and responses related to this upload.

]
Response
[
  {
    "id": 123,
    "fileName": "\"Assignment_Data_2025.xlsx\"",
    "uploadedFileUrl": "\"https://example.com/uploads/Assignment_Data_2025.xlsx\"",
    "scheduledDate": "\"2025-03-01T10:30:00\"",
    "uploadedOn": "\"2025-02-24T08:00:00\"",
    "dueDate": "\"2025-03-01T17:00:00\"",
    "uploadedByUid": "\"user123\"",
    "uploadedByDisplayName": "\"John Doe\"",
    "status": 1,
    "reviewerUid": "\"reviewer456\"",
    "reviewerName": "\"Jane Smith\"",
    "reviewerEmail": "\"jane.smith@example.com\"",
    "approvalStatus": "\"approved\"",
    "comments": "\"File looks good and ready for review.\"",
    "archived": false,
    "uploadProofs": [ … ]
  }
]