Skip to main content
API docs by Redocly

Marpps (0.0.17)

Download OpenAPI specification:Download

Marco Applications

Update existing marpp Deprecated

Update existing marco application

Authorizations:
ApplicationToken
path Parameters
marppId
required
string

Marco Application ID

Request Body schema: application/json
appURL
string
id
integer <int64>
imageURL
string
marppId
string
name
string
projectId
string
resourceId
string

Responses

Request samples

Content type
application/json
{
  • "appURL": "string",
  • "id": 0,
  • "imageURL": "string",
  • "marppId": "string",
  • "name": "string",
  • "projectId": "string",
  • "resourceId": "string"
}

Response samples

Content type
application/json
{
  • "appURL": "string",
  • "id": 0,
  • "imageURL": "string",
  • "marppId": "string",
  • "name": "string",
  • "projectId": "string",
  • "resourceId": "string"
}

Set marpp image Deprecated

Set marco application image

Authorizations:
ApplicationToken
path Parameters
marppId
required
string

Marco Application ID

Request Body schema: application/json
data
string
format
string

Responses

Request samples

Content type
application/json
{
  • "data": "string",
  • "format": "string"
}

Response samples

Content type
application/json
{
  • "appURL": "string",
  • "id": 0,
  • "imageURL": "string",
  • "marppId": "string",
  • "name": "string",
  • "projectId": "string",
  • "resourceId": "string"
}

Get marpp by app token Deprecated

Get marco applications by app token

Authorizations:
ApplicationToken
path Parameters
appToken
required
string

Application Token

Responses

Response samples

Content type
application/json
{
  • "appURL": "string",
  • "id": 0,
  • "imageURL": "string",
  • "marppId": "string",
  • "name": "string",
  • "projectId": "string",
  • "resourceId": "string"
}

Delete a Marpp by its id Deprecated

Delete Marco applications by its ID

Authorizations:
ApplicationToken
path Parameters
marppId
required
string

Marco Application ID

Responses

Get marpp by its id Deprecated

Get marco applications by its ID

Authorizations:
ApplicationToken
path Parameters
marppId
required
string

Marco Application ID

Responses

Response samples

Content type
application/json
{
  • "appURL": "string",
  • "id": 0,
  • "imageURL": "string",
  • "marppId": "string",
  • "name": "string",
  • "projectId": "string",
  • "resourceId": "string"
}

List featured marpps Deprecated

List featured marco applications

Authorizations:
ApplicationToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new marpp Deprecated

Create new marco application

Authorizations:
ApplicationToken
Request Body schema: application/json
appURL
string
id
integer <int64>
imageURL
string
marppId
string
name
string
projectId
string
resourceId
string

Responses

Request samples

Content type
application/json
{
  • "appURL": "string",
  • "id": 0,
  • "imageURL": "string",
  • "marppId": "string",
  • "name": "string",
  • "projectId": "string",
  • "resourceId": "string"
}

Response samples

Content type
application/json
{
  • "appURL": "string",
  • "id": 0,
  • "imageURL": "string",
  • "marppId": "string",
  • "name": "string",
  • "projectId": "string",
  • "resourceId": "string"
}

Get marpp's app token Deprecated

Get marco application's app token

Authorizations:
ApplicationToken
path Parameters
marppId
required
string

Marco Application ID

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

List Public marpps Deprecated

List Public marco applications

Authorizations:
ApplicationToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Page of marpps on project Deprecated

Page of marco applications in a project

Authorizations:
ApplicationToken
path Parameters
project
required
string

Marco Project

query Parameters
resourceId
string
Default: ""

The resourceId of the project that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "MarppPage"
}