Get Rules
GET
rules/{rulesKey}
Retrieves server-side generated code of the codeblocks contained in the provided rulesKey
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/rules/{rulesKey} |
| Authentication Context | user context required |
| Required OAuth Scopes | data:read data:write data:create account:read |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow. |
* Required
Request
URI Parameters
| rulesKey string | Key that uniquely identifies the uploaded file. |
Response
HTTP Status Code Summary
| 200 OK | The server-side generated code of the codeblocks was retrieved successfully. |
| 400 Bad Request | The server could not process your request. It is likely due to incorrect formatting or missing information. The response body may indicate what is wrong. Please review and resubmit your request. |
| 401 Unauthorized | The supplied authorization header was invalid or the token scope was not acceptable. Verify your authentication credentials and try again. |
| 403 Forbidden | The request was valid but lacked the necessary permissions. Verify your credentials and permissions before sending the request again. |
| 404 Not Found | The requested resource could not be found on the server. Review the request and try again. |
| 429 Too Many Requests | The server has received too many requests within the allowed time window. Please wait before retrying. |
| 500 Internal Server Error | An unexpected error occurred on the server. Please try again later. |
Response
Body Structure (200)
| lang string | The language of the rules. |
| code string | The rules code string. |
Example
The server-side generated code of the codeblocks was retrieved successfully.
Request
curl -v 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/rules/MGE0MTRmYjgtOTQ5Zi00YWMxLTg2ZmQtMzA4NzdlMDNjMDdiL1J1bGVzL2FmN2RmNTUyLTk4ZTUtNGYxOC04Mzk3LTg4ODljYzUyMTdmMS5qc29uLzQxMTBjYjRmLWYyMWItNGUyNS04MzdiLWRlMmExODNmZjg3Mg' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"lang": "",
"code": ""
}
