Box Developerドキュメント

Shield情報バリアのセグメントメンバーを作成

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

新しいShield情報バリアのセグメントメンバーを作成します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエスト本文

string本文内省略可能
"shield_information_barrier_segment_member"

-| Shieldバリアのセグメントメンバーのタイプ。

次の値に固定: shield_information_barrier_segment_member

Shield情報バリアオブジェクトのBase版の表示

リクエストされたShield情報バリアのセグメントのtypeid

"432554"

リクエストしているShield情報バリアのセグメントのID参照。

"shield_information_barrier_segment"

このメンバーのShieldバリアのセグメントのタイプ。

次の値に固定: shield_information_barrier_segment

ユーザー (Base) object本文内

制限が適用されるユーザー。

レスポンス

新しいShield情報バリアのセグメントメンバーオブジェクトを返します。

Shield情報バリアまたはセグメントが見つからなかった場合はエラーを返します。

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

post
Shield情報バリアのセグメントメンバーを作成
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

TypeScript Gen
await client.shieldInformationBarrierSegmentMembers.createShieldInformationBarrierSegmentMember(
  {
    shieldInformationBarrierSegment: {
      id: segment.id!,
      type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField,
    } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField,
    user: new UserBase({ id: getEnvVar('USER_ID') }),
  } satisfies CreateShieldInformationBarrierSegmentMemberRequestBody,
);
Python Gen
client.shield_information_barrier_segment_members.create_shield_information_barrier_segment_member(
    CreateShieldInformationBarrierSegmentMemberShieldInformationBarrierSegment(
        id=segment.id,
        type=CreateShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT.value,
    ),
    UserBase(id=get_env_var("USER_ID")),
)
.NET Gen
await client.ShieldInformationBarrierSegmentMembers.CreateShieldInformationBarrierSegmentMemberAsync(requestBody: new CreateShieldInformationBarrierSegmentMemberRequestBody(shieldInformationBarrierSegment: new CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField() { Id = NullableUtils.Unwrap(segment.Id), Type = CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField.ShieldInformationBarrierSegment }, user: new UserBase(id: Utils.GetEnvVar(name: "USER_ID"))));
Node
const barrierSegmentMember = await client.shieldInformationBarrierSegmentMembers.create({
	shield_information_barrier_segment: {
		id: '234',
		type: 'shield_information_barrier_segment'
	},
	user: {
		id: '456',
		type: 'user'
	}
});
console.log(`Shield information barrier segment member id ${barrierSegmentMember.id} created`);

レスポンスの例

{
  "id": "11446498",
  "type": "shield_information_barrier_segment_member",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "shield_information_barrier": {
    "id": "11446498",
    "type": "shield_information_barrier"
  },
  "shield_information_barrier_segment": {
    "id": "432554",
    "type": "shield_information_barrier_segment"
  },
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"
  },
  "user": {
    "id": "11446498",
    "type": "user"
  }
}