Deploy SML from a git repository

POST 
/v1/catalogs/deploy

Deploy SML from a git repository

Request

Header Parameters

Authorization string

application/json

Body

required

repoUrl urirequired
gitToken stringrequired

Possible values: non-empty

gitUsername string
branch string
catalogName string
catalogLabel string

tableauServers

object[]

Array [

name stringrequired

sites

object[]

required

Array [

siteName stringrequired

projectName string

Possible values: non-empty

newProject boolean

]

]

Responses

201

SML project compiled and deployed to the engine

application/json

Schema

Schema

catalogId uuidrequired

tableau

object[]

Array [

serverId uuidrequired

name stringrequired

siteName stringrequired

isSuccessful booleanrequired

errorMessage string

]

compilationWarnings

object

filesOutput

object[]

required

Array [

relativePath stringrequired

compilationOutput

object[]

required

Array [

severity stringrequired

message stringrequired

]

]

globalOutput

object[]

required

Array [

severity stringrequired

message stringrequired

]

Example (from schema)

{
  "catalogId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tableau": [
    {
      "serverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "siteName": "string",
      "isSuccessful": true,
      "errorMessage": "string"
    }
  ],
  "compilationWarnings": {
    "filesOutput": [
      {
        "relativePath": "string",
        "compilationOutput": [
          {
            "severity": "string",
            "message": "string"
          }
        ]
      }
    ],
    "globalOutput": [
      {
        "severity": "string",
        "message": "string"
      }
    ]
  }
}

400

Invalid request, package.yml detected, or compilation failed

401

Unauthorized

500

A server error occurred

Loading...