Action Module を作成

Actions 間で再利用できるコード用の新しい Action Module を作成します。

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

新しい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>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}/api/v2/actions/modules"

payload = {
    "code": "<string>",
    "name": "<string>",
    "api_version": "<string>",
    "dependencies": [
        {
            "name": "<string>",
            "version": "<string>"
        }
    ],
    "publish": True,
    "secrets": [
        {
            "name": "<string>",
            "value": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    name: '<string>',
    api_version: '<string>',
    dependencies: [{name: '<string>', version: '<string>'}],
    publish: true,
    secrets: [{name: '<string>', value: '<string>'}]
  })
};

fetch('https://{tenantDomain}/api/v2/actions/modules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/actions/modules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'name' => '<string>',
    'api_version' => '<string>',
    'dependencies' => [
        [
                'name' => '<string>',
                'version' => '<string>'
        ]
    ],
    'publish' => true,
    'secrets' => [
        [
                'name' => '<string>',
                'value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/actions/modules"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"api_version\": \"<string>\",\n  \"dependencies\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ],\n  \"publish\": true,\n  \"secrets\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/actions/modules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"api_version\": \"<string>\",\n  \"dependencies\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ],\n  \"publish\": true,\n  \"secrets\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/actions/modules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"name\": \"<string>\",\n  \"api_version\": \"<string>\",\n  \"dependencies\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ],\n  \"publish\": true,\n  \"secrets\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

code · string · 必須

Action Module のソースコード。

Maximum string length: 65536

Pattern: ^[^]*$

name · string · 必須

Action Module の名前。

Maximum string length: 255

Pattern: ^[^]*$

api_version · string

モジュールの API バージョン。

Maximum string length: 20

Pattern: ^[^]*$

dependencies · object[]

Action Module の npm 依存関係。

Show child attributes

publish · boolean

作成後すぐにモジュールを公開するかどうか。

secrets · object[]

Action Module に関連付けるシークレット。

Show child attributes

レスポンス

201

application/json

Action Module を作成しました。

actions_using_module_total · integer

このモジュールを使用しているデプロイ済み Actions の数。

all_changes_published · boolean

すべてのドラフト変更がバージョンとして公開済みかどうか。

code · string

モジュールのドラフトバージョンのソースコード。

created_at · string<date-time>

モジュールが作成されたタイムスタンプ。

dependencies · object[]

モジュールのドラフトバージョンの npm 依存関係。

Show child attributes

id · string

モジュールの一意の ID。

latest_version · object

参照オブジェクトとしての最新の公開済みバージョン。公開済みバージョンがない場合は省略されます。

Show child attributes

latest_version_number · integer

最新の公開済みバージョンのバージョン番号。バージョンが 1 つも公開されていない場合は省略されます。

name · string

モジュールの名前。

secrets · object[]

モジュールのドラフトバージョンのシークレット（名前とタイムスタンプのみで、値は返されません）。

Show child attributes

updated_at · string<date-time>

モジュールが最後に更新されたタイムスタンプ。