Object instances

Info for a specific object instance

get

Path parameters

projectIdstringRequired

The id of the project the object instance is in

instanceIdstringRequired

The id of the object instance to retrieve

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

get

HTTPcURLJavaScriptPython

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

{
  "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"
  }
}

Edit an object instance

post

Path parameters

projectIdstringRequired

The id of the project the object instance is in

instanceIdstringRequired

The id of the object instance to edit

Body

application/json

namestringOptional

descriptionstringOptional

enabledbooleanOptional

sourceone ofOptional

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/{instanceId} HTTP/1.1
Host: localhost:3050
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "name": "text",
  "description": "text",
  "enabled": true,
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "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"
  }
}