Openforge Catalog
  1. blueprint
Openforge Catalog
  • blueprint
    • returns all blueprints
      GET
    • Creates a blueprint
      POST
    • returns a blueprint by id
      GET
    • Updates a blueprint
      PATCH
    • Deletes a blueprint
      DELETE
    • Returns a list of blueprint ids that match a tag head
      GET
    • Returns a list of tags and their metadata for a blueprint
      GET
    • Resets a list of tags for a blueprint. This will remove existing tags and replace them with the ones passed in
      POST
    • Deletes all tags for a blueprint.
      DELETE
    • Creates a single tag for a blueprint.
      POST
    • Deletes a single tag for a blueprint.
      DELETE
  • tags
    • Queries tags for a list of blueprint ids
      POST
  • images
    • returns all blueprints
      GET
  • image
    • Creates an image
      POST
    • returns a image by id
      GET
    • Updates an image
      PATCH
  • iamge
    • Deletes an image
      DELETE
  1. blueprint

Creates a blueprint

POST
/api/blueprints
blueprint
Creates a blueprint

Request

Body Params application/json
id
string 
optional
Match pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
blueprint_name
string 
optional
blueprint_type
enum<string> 
optional
Allowed values:
modelblueprint
blueprint_config
object 
optional
file_md5
string 
optional
file_size
integer 
optional
file_name
string 
optional
full_name
string 
optional
file_changed_at
string <date-time>
optional
file_modified_at
string <date-time>
optional
storage_address
string 
optional
created_at
string <date-time>
optional
updated_at
string <date-time>
optional
tags
array[string]
optional
images
array [object {2}] 
optional
image_name
string 
optional
image_url
string 
optional
Example
{
    "id": "string",
    "blueprint_name": "string",
    "blueprint_type": "model",
    "blueprint_config": {},
    "file_md5": "string",
    "file_size": 0,
    "file_name": "string",
    "full_name": "string",
    "file_changed_at": "2019-08-24T14:15:22Z",
    "file_modified_at": "2019-08-24T14:15:22Z",
    "storage_address": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "tags": [
        "string"
    ],
    "images": [
        {
            "image_name": "string",
            "image_url": "string"
        }
    ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/blueprints' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "blueprint_name": "string",
    "blueprint_type": "model",
    "blueprint_config": {},
    "file_md5": "string",
    "file_size": 0,
    "file_name": "string",
    "full_name": "string",
    "file_changed_at": "2019-08-24T14:15:22Z",
    "file_modified_at": "2019-08-24T14:15:22Z",
    "storage_address": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "tags": [
        "string"
    ],
    "images": [
        {
            "image_name": "string",
            "image_url": "string"
        }
    ]
}'

Responses

🟢201Created
application/json
Blueprint created
Body
id
string 
optional
Match pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
blueprint_name
string 
optional
blueprint_type
enum<string> 
optional
Allowed values:
modelblueprint
blueprint_config
object 
optional
file_md5
string 
optional
file_size
integer 
optional
file_name
string 
optional
full_name
string 
optional
file_changed_at
string <date-time>
optional
file_modified_at
string <date-time>
optional
storage_address
string 
optional
created_at
string <date-time>
optional
updated_at
string <date-time>
optional
tags
array[string]
optional
images
array [object {2}] 
optional
image_name
string 
optional
image_url
string 
optional
Example
{
    "id": "string",
    "blueprint_name": "string",
    "blueprint_type": "model",
    "blueprint_config": {},
    "file_md5": "string",
    "file_size": 0,
    "file_name": "string",
    "full_name": "string",
    "file_changed_at": "2019-08-24T14:15:22Z",
    "file_modified_at": "2019-08-24T14:15:22Z",
    "storage_address": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "tags": [
        "string"
    ],
    "images": [
        {
            "image_name": "string",
            "image_url": "string"
        }
    ]
}
🟠400Bad Request
🟠401Unauthorized
Previous
returns all blueprints
Next
returns a blueprint by id
Built with