/

List all mml object instances

get

Path parameters

projectIdstringRequired

The id of the project the object is in

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 instances

application/json

default

An error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /v1/mml-objects/{projectId}/object-instances/ HTTP/1.1
Host: localhost:3050
Accept: */*

{
  "objects": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "url": "text",
      "enabled": true,
      "source": {
        "type": "template",
        "templateVersionId": {
          "templateId": "text",
          "versionId": "text",
          "alwaysDefault": false
        }
      },
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "createdAt": "text",
      "createdBy": {
        "userId": "text",
        "type": "user"
      }
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1
}

Create an object instance

post

Path parameters

projectIdstringRequired

The id of the project the object is in

Body

application/json

namestringRequired

descriptionstringOptional

enabledbooleanOptional

sourceone ofRequired

or

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

post

HTTPcURLJavaScriptPython

POST /v1/mml-objects/{projectId}/object-instances/ HTTP/1.1
Host: localhost:3050
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "name": "text",
  "description": "text",
  "enabled": true,
  "source": {
    "type": "template",
    "templateVersionId": {
      "templateId": "text",
      "versionId": "text",
      "alwaysDefault": false
    }
  }
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "url": "text",
  "enabled": true,
  "source": {
    "type": "template",
    "templateVersionId": {
      "templateId": "text",
      "versionId": "text",
      "alwaysDefault": false
    }
  },
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}