カスタム項目の管理

Exchange 管理者と組織のオーナーは、カスタム項目を作成して Exchange アセットメタデータモデルを拡張し、カスタムデータを任意のタイプのアセットに追加できます。

カスタム項目は、アセットバージョンに追加できるキー-値ペアです。

カスタム項目は管理されます。つまり、各アセットタイプに、システム管理者が定義した特定のスキーマがあります。これにより、Exchange は値を検証できます。たとえば、「SupportEndDate」という名前のカスタム項目設定をアセットに含めて、Exchange で、この項目に設定された値が有効な日付であることを保証できます。

Exchange では、アセット詳細ページにカスタム項目が表示されます。

アクセストークンの取得

以下のような cURL コマンドでアクセストークンを取得します。必要に応じて、cURL で HTTP コマンドを送信する代わりに、Postman や別のアプリケーションを使用できます。

YOUR_USERNAME を Anypoint Platform ユーザーアカウント名に置き換えて、YOUR_PASSWORD をそのパスワードに置き換えます。

ACCESS_TOKEN=$(curl https://anypoint.mulesoft.com/accounts/login -XPOST -d "username=YOUR_USERNAME&password=YOUR_PASSWORD" | jq -r ".access_token")

API コールでこのアクセストークンを使用して、カスタム項目を設定して割り当てます。

サポートされる型

Exchange は、enum (列挙)、number (数値)、date (日付)、text (テキスト)、数値のリスト、および文字列のリストの各型のカスタム項目をサポートします。

Enum (列挙)

次の例は、型が enum (列挙値のリスト)、名前が SubType、可能な値が OAS および RAML のカスタム項目を作成する方法を示しています。独自のカスタム項目を作成するには、組織 ID を設定し、-d フラグの後のデータパラメーターを変更します。

curl -X POST \
  https://anypoint.mulesoft.com/exchange/api/v2/organizations/:organizationId/fields \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"dataType": "enum",
	"acceptedValues": ["OAS","RAML"],
	"displayName": "SubType",
	"tagKey": "subType"
  }'

次の例は、この項目を組織の任意のアセットに追加する方法を示しています。項目を独自のアセットに追加するには、URL 内の組織 ID、グループ ID、アセット ID、およびバージョンを設定し、タグキー subType を、使用しているタグキーに変更し、-d フラグの後のデータパラメーターを変更します。

curl -X PUT \
  https://anypoint.mulesoft.com/exchange/api/v2/assets/:groupId/:assetId/:version/tags/fields/subType \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"tagValue": ["OAS"]
  }'

Number (数値)

次の例は、型が number、名前が Rating のカスタム項目を作成する方法を示しています。独自のカスタム項目を作成するには、組織 ID を設定し、-d フラグの後のデータパラメーターを変更します。

curl -X POST \
  https://anypoint.mulesoft.com/exchange/api/v2/organizations/:organizationId/fields \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"dataType": "number",
	"displayName": "Rating",
	"tagKey": "rating"
  }'

次の例は、この項目を組織の任意のアセットに追加する方法を示しています。項目を独自のアセットに追加するには、URL 内の組織 ID、グループ ID、アセット ID、およびバージョンを設定し、タグキー rating を、使用しているタグキーに変更し、-d フラグの後のデータパラメーターを変更します。

curl -X PUT \
  https://anypoint.mulesoft.com/exchange/api/v2/assets/:groupId/:assetId/:version/tags/fields/rating \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"tagValue": 5
  }'

Date (日付)

次の例は、型が date、名前が DueDate のカスタム項目を作成する方法を示しています。独自のカスタム項目を作成するには、組織 ID を設定し、-d フラグの後のデータパラメーターを変更します。

curl -X POST \
  https://anypoint.mulesoft.com/exchange/api/v2/organizations/:organizationId/fields \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"dataType": "date",
	"displayName": "DueDate",
	"tagKey": "dueDate"
  }'

次の例は、この項目を組織の任意のアセットに追加する方法を示しています。項目を独自のアセットに追加するには、URL 内の組織 ID、グループ ID、アセット ID、およびバージョンを設定し、タグキー dueDate を、使用しているタグキーに変更し、-d フラグの後のデータパラメーターを変更します。

curl -X PUT \
  https://anypoint.mulesoft.com/exchange/api/v2/assets/:groupId/:assetId/:version/tags/fields/dueDate \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"tagValue": "2020-01-01T20:00:00.000Z"
}'

Text (テキスト)

次の例は、型が text、名前が email のカスタム項目を作成する方法を示しています。独自のカスタム項目を作成するには、組織 ID を設定し、-d フラグの後のデータパラメーターを変更します。

curl -X POST \
  https://anypoint.mulesoft.com/exchange/api/v2/organizations/:organizationId/fields \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"dataType": "text",
	"displayName": "Email",
	"tagKey": "email"
  }'

次の例は、この項目を組織の任意のアセットに追加する方法を示しています。項目を独自のアセットに追加するには、URL 内の組織 ID、グループ ID、アセット ID、およびバージョンを設定し、タグキー email を、使用しているタグキーに変更し、-d フラグの後のデータパラメーターを変更します。

curl -X PUT \
  https://anypoint.mulesoft.com/exchange/api/v2/assets/:groupId/:assetId/:version/tags/fields/email \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"tagValue": "john@doe.com"
  }'

数値のリスト

次の例は、型が number-list、名前が SupportCases のカスタム項目を作成する方法を示しています。独自のカスタム項目を作成するには、組織 ID を設定し、-d フラグの後のデータパラメーターを変更します。

curl -X POST \
  https://anypoint.mulesoft.com/exchange/api/v2/organizations/:organizationId/fields \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"dataType": "number-list",
	"displayName": "SupportCases",
	"tagKey": "supportCases"
  }'

次の例は、この項目を組織の任意のアセットに追加する方法を示しています。項目を独自のアセットに追加するには、URL 内の組織 ID、グループ ID、アセット ID、およびバージョンを設定し、タグキー supportCases を、使用しているタグキーに変更し、-d フラグの後のデータパラメーターを変更します。

curl -X PUT \
  https://anypoint.mulesoft.com/exchange/api/v2/assets/:groupId/:assetId/:version/tags/fields/supportCases \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"tagValue": [1010,2020,3030]
  }'

文字列のリスト

次の例は、型が text-list、名前が Maintainers のカスタム項目を作成する方法を示しています。独自のカスタム項目を作成するには、組織 ID を設定し、-d フラグの後のデータパラメーターを変更します。

curl -X POST \
  https://anypoint.mulesoft.com/exchange/api/v2/organizations/:organizationId/fields \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"dataType": "text-list",
	"displayName": "Maintainers",
	"tagKey": "maintainers"
  }'

次の例は、この項目を組織の任意のアセットに追加する方法を示しています。項目を独自のアセットに追加するには、URL 内の組織 ID、グループ ID、アセット ID、およびバージョンを設定し、タグキー maintainers を、使用しているタグキーに変更し、-d フラグの後のデータパラメーターを変更します。

curl -X PUT \
  https://anypoint.mulesoft.com/exchange/api/v2/assets/:groupId/:assetId/:version/tags/fields/maintainers \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"tagValue": ["John", "Alice", "Fred"]
  }'

アセットタイプの制限

カスタム項目の追加先を特定のタイプのアセットに限定するようにカスタム項目を制限できます。次の例は、REST API にのみ適用されるカスタム項目を作成する方法を示しています。独自のカスタム項目を作成するには、組織 ID を設定し、-d フラグの後のデータパラメーターを変更します。

curl -X POST \
  https://anypoint.mulesoft.com/exchange/api/v2/organizations/:organizationId/fields \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
	"dataType": "enum",
	"acceptedValues": ["OAS","RAML"],
	"displayName": "SubType",
	"tagKey": "subType",
	"assetTypeRestrictions": ["rest-api"]
  }'

アセットバージョンからのカスタム項目の削除

次の例は、特定のアセットバージョンからカスタム項目 subType を削除する方法を示しています。カスタム項目を削除するには、組織 ID、グループ ID、アセット ID、およびバージョンを設定し、タグキー subType を、使用しているタグキーに変更します。

curl -X DELETE \
  https://anypoint.mulesoft.com/exchange/api/v2/assets/:groupId/:assetId/:version/tags/fields/subType \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

カスタム項目の削除

次の例は、組織のすべてのアセットからカスタム項目 subType を削除する方法を示しています。カスタム項目を削除するには、組織 ID を設定し、タグキー subType を、使用しているタグキーに変更します。

curl -X DELETE \
  https://anypoint.mulesoft.com/exchange/api/v2/organizations/:organizationId/fields/subType \
  -H 'Authorization: bearer $ACCESS_TOKEN' \
  -H 'Content-Type: application/json'