UOL Content Service

Attachments

Gets the CAD file using the specfied parameters.

Gets a CAD file to visualize a product using the specified ETIM class and ETIM model class..

Request

GET /api/v{version}/Attachments/{applicationName}/{applicationVersion}/{etimClassCode}/{etimClassCodeVersion}/{etimModelCode}/{etimModelCodeVersion}/{type}[?LanguageCode&MajorVersion&MinorVersion&attachmentNameOrId]

Parameters

Name	Type	Value	Notes
*applicationName	string		The name of the CAD application of the CAD file.
*applicationVersion	string		The version of the CAD application of the CAD file.
*etimClassCode	string		The ETIM class code of the CAD file.
*etimClassCodeVersion	string		The ETIM class code version of the CAD file.
*etimModelCode	string		The ETIM model class code of the CAD file.
*etimModelCodeVersion	string		The ETIM model class code version of the CAD file.
*type	string		The type of the attachment to get.
LanguageCode	string
MajorVersion	integer
MinorVersion	integer
attachmentNameOrId	string		The name of the ID of the attachment to get.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Export

Gets the ZIP export using the specfied parameters.

Gets a ZIP export containing files to visualize a product using the specified filter id.

Request

GET /api/v{version}/Export/{application}/{applicationVersion}/{filterId}/{languageCode}/{disabledFields}

Parameters

Name	Type	Value	Notes
*application	string		The name of the application (e.g. Revit) to find a compatible CAD file for.
*applicationVersion	string		The version of the application (e.g. Revit) to find a compatible CAD file for.
*filterId	string		The id of the filter.
*languageCode	string		A language code (e.g. 'EN' or 'NL') for the language that is used to generate the filename of the CAD file.
*disabledFields	string		The disabled product features.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
401	Unauthorized
404	Not Found
500	Server Error

Gets the products for the specified criteria.

Gets a ZIP export containing files to visualize a product using the specified cadProducts.

Request

POST /api/v{version}/Export/{application}/{applicationVersion}[?languageCode]

Parameters

Name	Type	Value	Notes
*application	string		The name of the application (e.g. Revit) to find a compatible CAD file for.
*applicationVersion	string		The version of the application (e.g. Revit) to find a compatible CAD file for.
cadProducts			A list of UOL.Models.CADProduct.
languageCode	string		A language code (e.g. 'EN' or 'NL') for the language that is used to generate the filename of the CAD file.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Files

Gets the CAD file using the specfied parameters.

Gets a CAD file to visualize a product using the specified ETIM class and ETIM model class..

Request

GET /api/v{version}/Files/{applicationName}/{applicationVersion}/{etimClassCode}/{etimClassCodeVersion}/{etimModelCode}/{etimModelCodeVersion}/{type}[?LanguageCode&MajorVersion&MinorVersion]

Parameters

Name	Type	Value	Notes
*applicationName	string		The name of the CAD application of the CAD file.
*applicationVersion	string		The version of the CAD application of the CAD file.
*etimClassCode	string		The ETIM class code of the CAD file.
*etimClassCodeVersion	string		The ETIM class code version of the CAD file.
*etimModelCode	string		The ETIM model class code of the CAD file.
*etimModelCodeVersion	string		The ETIM model class code version of the CAD file.
*type	string		The type of content to get the file for.
LanguageCode	string
MajorVersion	integer
MinorVersion	integer
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Posts a new CAD file to the online storage.

Posts a CAD file to the online storage.

Request

POST /api/v{version}/Files/{licenseCode}

Parameters

Name	Type	Value	Notes
*licenseCode	string		The license code to check if the call is permitted.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Metadata

Gets the Metadata using the specfied parameters.

Gets metadata of a product using the specified ETIM class and ETIM model class..

Request

GET /api/v{version}/Metadata/{applicationName}/{applicationVersion}/{etimClassCode}/{etimClassCodeVersion}/{etimModelCode}/{etimModelCodeVersion}[?LanguageCode&MajorVersion&MinorVersion]

Parameters

Name	Type	Value	Notes
*applicationName	string		The name of the CAD application for the CAD metadata.
*applicationVersion	string		The version of the CAD application for the CAD metadata.
*etimClassCode	string		The ETIM class code for the CAD metadata.
*etimClassCodeVersion	string		The ETIM class code version for the CAD metadata.
*etimModelCode	string		The ETIM model class code for the CAD metadata.
*etimModelCodeVersion	string		The ETIM model class code version for the CAD metadata.
LanguageCode	string
MajorVersion	integer
MinorVersion	integer
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Posts metadata for a CAD file.

Posts CAD file metadata to the online storage.

Request

POST /api/v{version}/Metadata/{blobId}/{licenseCode}

Parameters

Name	Type	Value	Notes
metadata			The metadata of the CAD file.
*blobId	string		The id of the blob containing the CAD file.
*licenseCode	string		The license code to check if the call is permitted.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
500	Server Error

MetadataBulk

Gets the Metadata using the specfied parameters.

Gets the most recent available metadata information for CAD files based on the supplied parameters.

Request

GET /api/v{version}/MetadataBulk/{applicationName}/{applicationVersion}/{includeMinorVersion}/{afterChangeDate}[?languageCode]

Parameters

Name	Type	Value	Notes
*applicationName	string		The name of the CAD application (e.g. Revit).
*applicationVersion	string		The version of the CAD application (e.g. 2020).
*includeMinorVersion	boolean		Specifies whether minor versions are to be included.
*afterChangeDate	string		Only return versions changed after this date (e.g. '2020-04-28'), if date is empty, null or not supplied return all versions.
languageCode	string		A language code (e.g. 'EN' or 'NL') for the language of the CAD file.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
500	Server Error

Posts multiple EC/MC criteria to get metadata in bulk.

Posts multiple EC/MC criteria to get metadata in bulk.

Request

POST /api/v{version}/MetadataBulk

Parameters

Name	Type	Value	Notes
metadataCriteria			The criteria to search for.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
500	Server Error

MetadataCurrentBulk

Posts multiple EC/MC criteria to get the most current metadata in bulk.

Posts multiple EC/MC criteria to get the most current metadata in bulk.

Request

POST /api/v{version}/MetadataCurrentBulk

Parameters

Name	Type	Value	Notes
metadataCriteria			The criteria to search for.
*version	string

Responses

Status Code	Description	Samples
200	A list of UOL.Models.CADMetadata with the metadata found by the criteria.
400	Bad Request
500	Server Error

Standard

Gets the CAD standard(s).

Gets CAD standards.

Request

GET /api/v{version}/Standard/{id}

Parameters

Name	Type	Value	Notes
*id	string		The id of the CAD Standard.
*version	string

Responses

Status Code	Description	Samples
200	Success
404	Not Found
500	Server Error

Posts a CAD standard.

Posts CAD standard to the online storage.

Request

POST /api/v{version}/Standard/licenseCode[?licenseCode]

Parameters

Name	Type	Value	Notes
standardName			The name of the standard to add.
licenseCode	string		The license code to verify if adding standards is allowed.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
500	Server Error

ValidationFiles

Gets the validation file using the specfied parameters.

Gets a validation file to use for validation.

Request

GET /api/v{version}/ValidationFiles/{blobId}

Parameters

Name	Type	Value	Notes
*blobId	string		The id of the blob with the data to validate.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Posts a new Validation file to the online storage.

Posts a validation file to the online storage.

Request

POST /api/v{version}/ValidationFiles

Parameters

Name	Type	Value	Notes
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

ValidationRequest

Gets the validation requests using the specfied parameters.

Gets the validation requests for a specific project id and ticket number if specified.

Request

GET /api/v{version}/ValidationRequest/{projectId}/{ticketNumber}

Parameters

Name	Type	Value	Notes
*projectId	string		The project id to find validation requests for.
*ticketNumber	string		The ticket number to find validation requests for.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Deletes the validation requests using the specified parameters.

Deletes the validation requests for a specific project id and ticket number if specified.

Request

DELETE /api/v{version}/ValidationRequest/{projectId}/{ticketNumber}

Parameters

Name	Type	Value	Notes
*projectId	string		The project id to find validation requests for.
*ticketNumber	string		The ticket number to find validation requests for.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Posts validation request.

Posts a validation request to the online storage.

Request

POST /api/v{version}/ValidationRequest

Parameters

Name	Type	Value	Notes
validationRequest			The validation request data to post.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
500	Server Error

ValidationRequests

Gets the validation requests using the specfied parameters.

Gets the validation requests for a specific project id, project name and ticket number if specified.

Request

GET /api/v{version}/ValidationRequests/{projectId}/{projectName}/{ticketNumber}

Parameters

Name	Type	Value	Notes
*projectId	string		The project id to find validation requests for.
*projectName	string		The name of the project to find validation requests for.
*ticketNumber	string		The ticket number to find validation requests for.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Deletes the validation requests using the specified parameters.

Deletes the validation requests for a specific project id, project name and ticket number.

Request

DELETE /api/v{version}/ValidationRequests/{projectId}/{projectName}/{ticketNumber}

Parameters

Name	Type	Value	Notes
*projectId	string		The project id to delete validation requests for.
*projectName	string		The project name to delete validation requests for.
*ticketNumber	string		The ticket number to delete validation requests for.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
404	Not Found
500	Server Error

Versions

Gets the CAD file using the specfied parameters.

Gets the available versions for a CAD file to visualize a product using the specified ETIM class and ETIM model class..

Request

GET /api/v{version}/Versions/{applicationName}/{applicationVersion}/{etimClassCode}/{etimClassCodeVersion}/{etimModelCode}/{etimModelCodeVersion}/{type}[?LanguageCode&MajorVersion&MinorVersion]

Parameters

Name	Type	Value	Notes
*applicationName	string		The name of the CAD application for the CAD metadata.
*applicationVersion	string		The version of the CAD application for the CAD metadata.
*etimClassCode	string		The ETIM class code for the CAD metadata.
*etimClassCodeVersion	string		The ETIM class code version for the CAD metadata.
*etimModelCode	string		The ETIM model class code for the CAD metadata.
*etimModelCodeVersion	string		The ETIM model class code version for the CAD metadata.
*type	string		The type of content to get the versions for.
LanguageCode	string
MajorVersion	integer
MinorVersion	integer
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
500	Server Error

Releases a new major version for a CAD file.

Releases a new major version for the CAD file.

Request

PUT /api/v{version}/Versions/Release/{applicationName}/{applicationVersion}/{etimClassCode}/{etimClassCodeVersion}/{etimModelCode}/{etimModelCodeVersion}/{type}/{licenseCode}[?LanguageCode&MajorVersion&MinorVersion]

Parameters

Name	Type	Value	Notes
*applicationName	string		The name of the CAD application for the CAD metadata.
*applicationVersion	string		The version of the CAD application for the CAD metadata.
*etimClassCode	string		The ETIM class code for the CAD metadata.
*etimClassCodeVersion	string		The ETIM class code version for the CAD metadata.
*etimModelCode	string		The ETIM model class code for the CAD metadata.
*etimModelCodeVersion	string		The ETIM model class code version for the CAD metadata.
*type	string		The type of content to get the versions for.
*licenseCode	string		The license code to check if the call is permitted.
LanguageCode	string
MajorVersion	integer
MinorVersion	integer
comments			The comments for the publish.
*version	string

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
500	Server Error