[API] Create Report URL for the report
This endpoint is for creating a signed url for the generated report.
v1/vehicle-suppliers/suppliers/:org_id/reports/:report_id/link
¶ HTTP Method
POST
¶ Access Method
¶ Required scopes
Primary - solutions.suppliers.reports
¶ Usage
The client should access the Get Organizations API that fetches the child organizations for the given organisation. This API returns the encrypted IDs for the linked organizations . The clients can then use the encrypted organization ID in the below request to generate a signed url for the reports which are in generated status for getting the targeted file content. For getting the master organisation’s encrypted uuid please reach out to support team.
¶ Example Request
curl --location --request POST
-D 'https://api.uber.com/v1/vehicle-suppliers/suppliers/<org_id>/reports/<report_id>/link' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
¶ Request Path Parameters
Name | Type | Required | Description |
---|---|---|---|
org_id |
string | Y | This represents encrypted organisation UUID. |
report_id |
string | Y | Id of the generated report. |
Response Fields
Name | Type | Description |
---|---|---|
data | Object of SignedUrl | This has details for the generated signed url. |
Response Entities
Name | Type | Description |
---|---|---|
value |
string | This is the url where the csv data has been uploaded. |
¶ Example Response
{
"data": {
"signedUrl": {
"value": "www.example.com/files/abc.csv"
}
}
}
¶ Notes
- The singed URL returned in the response will have a validity of 60secs from the time when the request was sent. Post 60sec accessing the signed URL will return an “Access Denied” error.
Rate Limit
- Rate limit for this endpoint is 600 requests per 10 minutes per Developer Application.
¶ Endpoint Specific Errors
Http Status Code | Code | Message |
---|---|---|
400 |
bad_request | The request parameters are invalid. |
500 |
internal_server_error | Internal server error. |
403 |
unauthenticated | User does not have permission. |
429 |
rate_limited | Number of requests exceeds allowed limit. |
503 |
service_unavailable | Service unavailable. |
401 |
unauthorized | Invalid OAuth 2.0 credentials. |