Zum Inhalt springen
AcrivaDocs

CreateDataSource

POST
/api/v1/t/{tenant}/workflows/data-sources
curl --request POST \
  --url https://example.com/api/v1/t/example/workflows/data-sources \
  --header 'Content-Type: application/json' \
  --data '{ "key": "example", "baseUrl": "example", "authentication": "None", "headerName": "example", "username": "example", "secret": "example", "timeoutSeconds": 1, "cacheSeconds": 1, "responseSchema": "example", "allowConfidential": true }'

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

Request Bodyrequired

Abschnitt betitelt „Request Bodyrequired“
Media typeapplication/json
object
key
required
string
baseUrl
required
string
authentication
required
Allowed values: None Bearer Basic ApiKeyHeader
headerName
required
null | string
username
required
null | string
secret
required
null | string
timeoutSeconds
required
integer format: int32
cacheSeconds
required
integer format: int32
responseSchema
required
null | string
allowConfidential
required
boolean

Responses

Abschnitt betitelt „ Responses “

201

Abschnitt betitelt „201“

Created

Media typeapplication/json
object
key
required
string
baseUrl
required
string
authentication
required
Allowed values: None Bearer Basic ApiKeyHeader
headerName
required
null | string
username
required
null | string
hasSecret
required
boolean
timeoutSeconds
required
integer format: int32
cacheSeconds
required
integer format: int32
responseSchema
required
null | string
allowConfidential
required
boolean
version
required
integer format: uint32
updatedBy
required
string format: uuid
updatedAt
required
string format: date-time
lastCall
required
One of:
null
Example
{
  "authentication": "None",
  "lastCall": {
    "outcome": "Succeeded"
  }
}

400

Abschnitt betitelt „400“

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Abschnitt betitelt „403“

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Abschnitt betitelt „409“

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Abschnitt betitelt „429“

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

503

Abschnitt betitelt „503“

Service Unavailable

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}