Box Developerドキュメント
最新バージョン

サービス利用規約を作成

post
https://api.box.com/2.0
/terms_of_services

指定した企業とユーザータイプに適用されるサービス利用規約を作成します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエスト本文

string本文内必須
"enabled"

このサービス利用規約がアクティブであるかどうか。

次の値のいずれか1つ: enabled,disabled

string本文内必須
"By collaborating on this file you are accepting..."

ユーザーに対して表示されるサービス利用規約のテキスト。

statusdisabledに設定されている場合は、テキストを空に設定できます。

string本文内省略可能
"managed"

サービス利用規約を設定するユーザーのタイプ。

次の値のいずれか1つ: external,managed

レスポンス

新しいタスクオブジェクトを返します

予期しないクライアントエラー。

post
サービス利用規約を作成
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/terms_of_services" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "status": "enabled",
       "text": "By collaborating on this file you are accepting..."
     }'
TypeScript Gen
await client.termsOfServices.createTermsOfService({
  status: 'disabled' as CreateTermsOfServiceRequestBodyStatusField,
  tosType: 'managed' as CreateTermsOfServiceRequestBodyTosTypeField,
  text: 'Test TOS',
} satisfies CreateTermsOfServiceRequestBody);
Python Gen
client.terms_of_services.create_terms_of_service(
    CreateTermsOfServiceStatus.DISABLED,
    "Test TOS",
    tos_type=CreateTermsOfServiceTosType.MANAGED,
)
.NET Gen
await client.TermsOfServices.CreateTermsOfServiceAsync(requestBody: new CreateTermsOfServiceRequestBody(status: CreateTermsOfServiceRequestBodyStatusField.Disabled, text: "Test TOS") { TosType = CreateTermsOfServiceRequestBodyTosTypeField.Managed });
Java
BoxTermsOfService.Info newTOS = BoxTermsOfService.create(
    api,
    BoxTermsOfService.TermsOfServiceStatus.ENABLED,
    BoxTermsOfService.TermsOfServiceType.EXTERNAL,
    "Terms of Service..."
);
Python
from boxsdk.object.terms_of_service import TermsOfServiceType, TermsOfServiceStatus
terms_of_service = client.create_terms_of_service(TermsOfServiceStatus.ENABLED,TermsOfServiceType.MANAGED, 'Example Text')
print(f'Terms of Service status is {terms_of_service.status} and the message is {terms_of_service.text}')
.NET
var tosParams = new CreateTermsOfServicesAsync()
{
    Status = "enabled"
    TosType = "external",
    Text = "By using this service, you agree to ..."
};
BoxTermsOfService tos = await client.TermsOfServiceManager.CreateTermsOfServicesAsync(tosParams);
Node
client.termsOfService.create('managed', 'enabled', 'By using this service, you agree to ...')
	.then(tos => {
		/* tos -> {
			type: 'terms_of_service',
			id: '12345',
			status: 'enabled',
			enterprise: { type: 'enterprise', id: '55555' },
			tos_type: 'managed',
			text: 'By using this service, you agree to ...',
			created_at: '2018-04-19T13:55:09-07:00',
			modified_at: '2018-04-19T13:55:09-07:00' }
		*/
	});
iOS
client.termsOfService.create(
    status: .enabled,
    tosType: .managed,
    text: "Test Terms of Service"
) { (result: Result<TermsOfService, BoxSDKError>) in
    guard case let .success(termsOfService) = result else {
        print("Error creating terms of service")
        return
    }
    print("Terms of Service with id: \(termsOfService.id) was created")
}

レスポンスの例

{
  "id": "11446498",
  "type": "terms_of_service",
  "created_at": "2012-12-12T10:53:43-08:00",
  "enterprise": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "modified_at": "2012-12-12T10:53:43-08:00",
  "status": "enabled",
  "text": "By using this service, you agree to ...",
  "tos_type": "managed"
}