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

post

https://api.box.com/2.0

/shield_information_barrier_segment_members

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

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

リクエスト本文

type string本文内省略可能

例"shield_information_barrier_segment_member"

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

次の値に固定: shield_information_barrier_segment_member

shield_information_barrierShield情報バリア (Base) object本文内

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

shield_information_barrier_segment object本文内

リクエストされたShield情報バリアのセグメントのtypeとid。

shield_information_barrier_segment.id string本文内必須

例"432554"

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

shield_information_barrier_segment.type string本文内必須

例"shield_information_barrier_segment"

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

次の値に固定: shield_information_barrier_segment

userユーザー (Base) object本文内

リクエストされたShield情報バリアのセグメントメンバーのtypeとid。

レスポンス

201application/jsonShield情報バリアのセグメントメンバー

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

404application/jsonクライアントエラー

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

defaultapplication/jsonクライアントエラー

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

post

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

このドキュメント内で一部のAPIを試せるようになりました。

リクエストの例

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