Crear un Action Module

Cree un nuevo Actions Module para reutilizar código en distintas acciones.

POST https://{tenantDomain}/api/v2/actions/modules

Crear un nuevo Actions Module

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/actions/modules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "name": "<string>",
  "api_version": "<string>",
  "dependencies": [
    {
      "name": "<string>",
      "version": "<string>"
    }
  ],
  "publish": true,
  "secrets": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}
'

201

{
  "actions_using_module_total": 123,
  "all_changes_published": true,
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "dependencies": [
    {
      "name": "<string>",
      "version": "<string>"
    }
  ],
  "id": "<string>",
  "latest_version": {
    "code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "dependencies": [
      {
        "name": "<string>",
        "version": "<string>"
      }
    ],
    "id": "<string>",
    "secrets": [
      {
        "name": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "version_number": 123
  },
  "latest_version_number": 123,
  "name": "<string>",
  "secrets": [
    {
      "name": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cuerpo

application/jsonapplication/x-www-form-urlencoded

code · string · requerido

El código fuente del módulo de Action.

Maximum string length: 65536

Pattern: ^[^]*$

name · string · requerido

El nombre del módulo de Action.

Maximum string length: 255

Pattern: ^[^]*$

api_version · string

La versión de la API del módulo.

Maximum string length: 20

Pattern: ^[^]*$

dependencies · object[]

Las dependencias npm del módulo de Action.

Show child attributes

publish · boolean

Si el módulo debe publicarse inmediatamente después de crearse.

secrets · object[]

Los secrets que se asociarán con el módulo de Action.

Show child attributes

Respuesta

201

application/json

Se creó el Actions Module.

actions_using_module_total · integer

La cantidad de Actions desplegados que usan este módulo.

all_changes_published · boolean

Si todos los cambios del borrador se han publicado como una versión.

code · string

El código fuente de la versión en borrador del módulo.

created_at · string<date-time>

Marca de tiempo en que se creó el módulo.

dependencies · object[]

Las dependencias npm de la versión en borrador del módulo.

Show child attributes

id · string

El ID único del módulo.

latest_version · object

La versión publicada más reciente como objeto de referencia. Se omite si no se ha publicado ninguna versión.

Show child attributes

latest_version_number · integer

El número de la versión publicada más reciente. Se omite si no se ha publicado ninguna versión.

name · string

El nombre del módulo.

secrets · object[]

Los secrets de la versión en borrador del módulo (solo nombres y marcas de tiempo; los valores nunca se devuelven).

Show child attributes

updated_at · string<date-time>

Marca de tiempo de la última actualización del módulo.