/

List all mml object template versions

get
Path parameters
projectIdstringRequired

The id of the project the template is in

templateIdstringRequired

The id of the template to list versions for

Query parameters
offsetinteger · int32Optional

The offset into queried items to return

limitinteger · int32 · max: 100Optional

How many items to return at one time (max 100)

Responses
200

A paged array of MML object template versions

application/json
get
GET /v1/mml-objects/{projectId}/object-templates/{templateId}/versions/ HTTP/1.1
Host: localhost:3050
Accept: */*
{
  "templateVersions": [
    {
      "id": "text",
      "description": "text",
      "source": "text",
      "parametersSchema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "createdAt": "text",
      "createdBy": {
        "userId": "text",
        "type": "user"
      }
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1
}

Create an object template version

post
Path parameters
projectIdstringRequired

The id of the project the template is in

templateIdstringRequired

The id of the template to create a version for

Body
idstringRequired
descriptionstringOptional
sourcestringRequired
setAsDefaultbooleanOptional
Responses
200

Expected response to a valid request

application/json
post
POST /v1/mml-objects/{projectId}/object-templates/{templateId}/versions/ HTTP/1.1
Host: localhost:3050
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "id": "text",
  "description": "text",
  "source": "text",
  "parametersSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "setAsDefault": true
}
{
  "id": "text",
  "description": "text",
  "source": "text",
  "parametersSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}

Info for a specific template version

get
Path parameters
projectIdstringRequired

The id of the project the template version is in

templateIdstringRequired

The id of the template version to retrieve

versionIdstringRequired

The id of the template version to retrieve

Responses
200

Expected response to a valid request

application/json
get
GET /v1/mml-objects/{projectId}/object-templates/{templateId}/versions/{versionId}/ HTTP/1.1
Host: localhost:3050
Accept: */*
{
  "id": "text",
  "description": "text",
  "source": "text",
  "parametersSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}

Edit a template version

post
Path parameters
projectIdstringRequired

The id of the project the template version is in

templateIdstringRequired

The id of the template version to edit

versionIdstringRequired

The id of the template version to edit

Body
descriptionstringOptional
Responses
200

Expected response to a valid request

application/json
post
POST /v1/mml-objects/{projectId}/object-templates/{templateId}/versions/{versionId}/ HTTP/1.1
Host: localhost:3050
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "description": "text"
}
{
  "id": "text",
  "description": "text",
  "source": "text",
  "parametersSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}

Was this helpful?