Parametric

Update Parametric Component

put

Modifies a parametric component.

Authorizations

open-api-key

Path parameters

idstringRequired

Component ID

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

put/api/v1/parametric/components/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/parametric/components/{id} HTTP/1.1
Host: openapi.archisketch.com
Content-Type: application/json
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Create Parametric Component

post

Creates a new parametric component.

Authorizations

open-api-key

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

post/api/v1/parametric

HTTPcURLJavaScriptPython

POST /api/v1/parametric HTTP/1.1
Host: openapi.archisketch.com
Content-Type: application/json
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Get Component Parameter List

get

Retrieves the parameter list of a parametric component.

Authorizations

open-api-key

Path parameters

componentIdstringRequired

Component ID

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

get/api/v1/parametric/components/{componentId}/parameters

HTTPcURLJavaScriptPython

GET /api/v1/parametric/components/{componentId}/parameters HTTP/1.1
Host: openapi.archisketch.com
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Create Component Parameters

post

Creates parameters in a parametric component.

Authorizations

open-api-key

Path parameters

componentIdstringRequired

Component ID

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

post/api/v1/parametric/components/{componentId}/parameters

HTTPcURLJavaScriptPython

POST /api/v1/parametric/components/{componentId}/parameters HTTP/1.1
Host: openapi.archisketch.com
Content-Type: application/json
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Modify Parameter Information

post

Modifies parameter information.

Authorizations

open-api-key

Path parameters

parameterIdstringRequired

Parameter ID

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

post/api/v1/parametric/components/parameters/{parameterId}

HTTPcURLJavaScriptPython

POST /api/v1/parametric/components/parameters/{parameterId} HTTP/1.1
Host: openapi.archisketch.com
Content-Type: application/json
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Delete Single Parameter

delete

Deletes a single parameter.

Authorizations

open-api-key

Path parameters

parameterIdstringRequired

Parameter ID

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

delete/api/v1/parametric/components/parameters/{parameterId}

HTTPcURLJavaScriptPython

DELETE /api/v1/parametric/components/parameters/{parameterId} HTTP/1.1
Host: openapi.archisketch.com
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content