[Submission] Read a submission.
https://api.wetransform.com/sender/submission/{submissionId}
| Parameter | Description | Pattern |
|---|---|---|
{submissionId} |
The submission UUID to read |
[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12} |
success
boolean
Always true on successful responses.
true
payload
object
Payload of the requested resource.
payload.submission_id
*
string
The submission UUID
"0e33521c-85b7-4a2f-b7f1-48348d00db8d"
payload.customer_id
*
string
The customer external ID
"jojo"
payload.customer_name
*
string
The customer name
"Jo\u00ebl"
payload.customer_email
*
string
The customer email
"joel@fuz.org"
payload.source_id
*
string
The source UUID
"e4406ce0-3f4d-4d99-8bbf-da86e104cc19"
payload.source_name
*
string
The source name
"New Hires"
payload.source_file_url
*
string
The source file URL, if it still exists
"https:\/\/example.com\/source.csv"
payload.target_file_url
*
string
The target file URL
"https:\/\/example.com\/target.csv"
payload.error_report_url
*
string
The error report url.
"https:\/\/example.com\/error-report.csv"
payload.push_report_url
*
string
The push report url.
"https:\/\/example.com\/push-report.csv"
payload.download_url
*
string
The permanent download URL for this transformation's output file.
"https:\/\/example.com\/download.csv"
payload.target_name
*
string
The target file naem.
payload.template_name
*
string
The template name
"New Hires"
payload.template_item
*
string
The template item name
Useful to render the number of items in source, target, and errors.
"Employee"
payload.template_picture_url
*
string
The template picture URL, if any
"https:\/\/example.com\/picture.png"
payload.rows_in_source
*
integer
Number of rows that were imported from the source file.
100
payload.rows_ignored_from_source
*
integer
Number of rows that were ignored in the source file.
0
payload.columns_ignored_from_source
*
integer
Number of columns that were ignored in the source file.
0
payload.maximum_number_of_columns
integer
Maximum number of columns allowed.
1016
payload.rows_in_target
*
integer
Number of rows in the target file.
100
payload.rows_in_error
*
integer
Number of rows in error.
12
payload.rows_ignored_from_target
*
integer
Number of rows truncated from the target file because of insufficient line credit.
0
payload.created_at
*
datetime
The date at which the submission has been created.
payload.pushed_at
*
datetime
The date at which the receiver was notified that the submission's target file is ready
— set either when the configured Push (HTTP request to the receiver's API) completes,
or when the READY_FOR_DOWNLOAD webhook fires. Despite the name, this does NOT
imply a Push integration is configured on the template.
payload.failed
boolean
Whether the submission has failed.
false
payload.error_message
*
string
If the submission has failed, the error message.
product
*
object
A product needed.
Not null if user requires to buy a specific product (permission or limitation) in order to access a feature.
product.requirement
*
string
Whether the user requested a features s/he doesn't have access to,
or the user needs greater limits.
Possible values: permission, limitation
"permission"
product.permission
*
object
The required permission.
You will need to know which permission is needed in order to fill up search filters in the shop.
product.permission.description
*
string
A human-understandable name for the permission.
product.permission.name
string
A technical permission name (ex: ORGANISATION_UPDATE_SETTINGS).
Possible values depend on the context, check the domain's metadata endpoint.
"X_SOURCE_FORMAT_XML"
product.limitation_type
*
string
The limitation that needs to be increased (ex: number of columns).
product.limitation_needed_value
*
integer
The needed resource quantity (if receiver uses 9 columns in a template, this value is 9).
product.limitation_current_value
*
integer
The current value of the limitation (if receiver is allowed to use 10 columns, this value is 10).
product.limitation_object
*
object
The limitation type in a readable format, for example, "lines per file".
product.is_cta
*
boolean
Whether a Call To Action should be displayed.
It may not be displayed if:
- the limitation is on the membership role
- the limitation is on the customer role
- the user is a sender
template_handle
*
string
Handle of the template currently in context, if any.
Many endpoints (and frontend components) require a template_handle. It is
exposed here so consumers — most notably the AI agent — can reuse it
instead of having to ask the user for it again.
"new-hires"
source_id
*
string
UUID of the source currently in context, if any.
Many endpoints (and frontend components) require a source_id (the source
UUID, not its database id). It is exposed here so consumers — most notably
the AI agent — can reuse it instead of having to ask the user for it again.
"9e7060d4-9314-4783-883a-8702471ccd39"
debug
array
Debug information.
Contains logs about business logic explaining state of the response payload.
Provided in development & admin modes only.
* are nullable.
{
"success": true,
"payload": {
"submission_id": "0e33521c-85b7-4a2f-b7f1-48348d00db8d",
"customer_id": "jojo",
"customer_name": "Jo\u00ebl",
"customer_email": "joel@fuz.org",
"source_id": "e4406ce0-3f4d-4d99-8bbf-da86e104cc19",
"source_name": "New Hires",
"source_file_url": "https:\/\/example.com\/source.csv",
"target_file_url": "https:\/\/example.com\/target.csv",
"error_report_url": "https:\/\/example.com\/error-report.csv",
"push_report_url": "https:\/\/example.com\/push-report.csv",
"download_url": "https:\/\/example.com\/download.csv",
"target_name": null,
"template_name": "New Hires",
"template_item": "Employee",
"template_picture_url": "https:\/\/example.com\/picture.png",
"rows_in_source": 100,
"rows_ignored_from_source": 0,
"columns_ignored_from_source": 0,
"maximum_number_of_columns": 1016,
"rows_in_target": 100,
"rows_in_error": 12,
"rows_ignored_from_target": 0,
"created_at": "2020-12-31T23:59:55+00:00",
"pushed_at": "2021-01-01T00:00:00+00:00",
"failed": false,
"error_message": null
},
"product": {
"requirement": "permission",
"permission": {
"name": "X_SOURCE_FORMAT_XML",
"description": "Can import XML files"
},
"limitation_type": null,
"limitation_needed_value": null,
"limitation_current_value": null,
"limitation_object": null,
"is_cta": false
},
"template_handle": "new-hires",
"source_id": "9e7060d4-9314-4783-883a-8702471ccd39",
"debug": []
}User is well authenticated, but not authorized to access the resource.
It can happen if user is trying to use a feature that s/he didn't pay for, access someone else's resource, etc.
These issues are normally fixed by the frontend, which should render features and resources user has access to.
success
boolean
Always false on error responses.
false
payload
object
Context about the error, if any.
product
*
object
A product needed.
Not null if user requires to buy a specific product (permission or limitation) in order to access a feature.
product.requirement
*
string
Whether the user requested a features s/he doesn't have access to,
or the user needs greater limits.
Possible values: permission, limitation
"permission"
product.permission
*
object
The required permission.
You will need to know which permission is needed in order to fill up search filters in the shop.
product.permission.description
*
string
A human-understandable name for the permission.
product.permission.name
string
A technical permission name (ex: ORGANISATION_UPDATE_SETTINGS).
Possible values depend on the context, check the domain's metadata endpoint.
"X_SOURCE_FORMAT_XML"
product.limitation_type
*
string
The limitation that needs to be increased (ex: number of columns).
product.limitation_needed_value
*
integer
The needed resource quantity (if receiver uses 9 columns in a template, this value is 9).
product.limitation_current_value
*
integer
The current value of the limitation (if receiver is allowed to use 10 columns, this value is 10).
product.limitation_object
*
object
The limitation type in a readable format, for example, "lines per file".
product.is_cta
*
boolean
Whether a Call To Action should be displayed.
It may not be displayed if:
- the limitation is on the membership role
- the limitation is on the customer role
- the user is a sender
template_handle
*
string
Handle of the template currently in context, if any.
Many endpoints (and frontend components) require a template_handle. It is
exposed here so consumers — most notably the AI agent — can reuse it
instead of having to ask the user for it again.
"new-hires"
source_id
*
string
UUID of the source currently in context, if any.
Many endpoints (and frontend components) require a source_id (the source
UUID, not its database id). It is exposed here so consumers — most notably
the AI agent — can reuse it instead of having to ask the user for it again.
"9e7060d4-9314-4783-883a-8702471ccd39"
debug
array
Debug information.
Contains logs about business logic explaining state of the response payload.
Provided in development & admin modes only.
* are nullable.
{
"success": false,
"payload": [],
"product": {
"requirement": "permission",
"permission": {
"name": "X_SOURCE_FORMAT_XML",
"description": "Can import XML files"
},
"limitation_type": null,
"limitation_needed_value": null,
"limitation_current_value": null,
"limitation_object": null,
"is_cta": false
},
"template_handle": "new-hires",
"source_id": "9e7060d4-9314-4783-883a-8702471ccd39",
"debug": []
}