Sign in
latestOpenAPI 3.0.12026-08-082942150.5 KB

14cab8ac3bca

Input Units

Get Project Errors

After the synchronous upload is completed successfully, the asynchronous process is triggered. Validation errors during this phase will change the project state to either UPLOAD ERRORS or INSUFFICIENT DATA, depending on whether there is valid input unit(s). A detailed list of errors will be returned. Review the error list and re-upload the set using the same Input Unit ID.

List of possible errors:

Error TypesDescription
ConnectionUnsuccessfulConnection to the URL provider was unsuccessful
UrlNotSupportedThe provided URL is not formatted over HTTP, HTTPS or S3 protocols
FileDoesNotExist

Possible values for errorDetails field:

  • NoSuchKey.

  • NoSuchBucket. | The provided URL does not contain a file or, if S3 protocol is used, the specified key/bucket does not exist. | | FileIsNotValid

Possible values for errorDetails field:

  • .WAV file failed format validations. Check public API documentation or contact Enterprise Support.

  • .WAV file failed validation: fmt chunk size must be greater than or equal to 16.

  • .WAV file failed validation: bits per sample must be between 4 and 16.

  • .WAV file failed validation: PCM audio format is required.

  • .WAV file failed validation: number of channels must be between 1 and 8. | The provided URL contains invalid file formats (accepted file formats: audio (.wav)) | | UnauthorizedAccess | The provided URL cannot be accessed due to authentication issues | | StatusCodeDoesNotIndicateSuccess

Possible values for errorDetails field:

  • e.g. 429 TooManyRequests. | Remote server returned an error when queried resource under corresponding URL. Please, see errorDetails for actual error code and error message. | | PlatformError | Something went wrong on our side |

Sample:

{
    "uploadInputUnitsError":
    [
        {
            "inputDataUnitId": "00000000-0000-0000-0000-000000000000",
        
            "errorType": "FileIsNotValid",
        
            "errorDetails": ".WAV file failed validation: ChunkSize should always be 16 (PCM format) or greater. ",
        
            "errorProperty": {
                "inputDataUnitProperty": "audioSample",
        
                "inputDataUnitPropertyValue": "http://example.com"
            },
        
            "inputDataUnit": { }
        }
    ],
    "totalCount": 1
}

Permission Required: Read Project Properties

get/v2.0/public/projects/{projectId}/errors

Path parameters

projectIdstring uuid required
Example:00000000-0000-0000-0000-000000000000

Project ID.

Query parameters

pageNumberinteger

The page to retrieve.

itemsPerPageinteger

The number of items to retrieve per page. The maximum number of items per page allowed is 100.

uploadIdstring uuid
Example:00000000-0000-0000-0000-000000000000

ID for a set of uploaded input units.

Response

Returns a list with project information.

totalCountinteger

Total number of items available.

Example response

{
  "uploadInputUnitsError": [
    {
      "inputDataUnitId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}