Box Developerドキュメント

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

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

Shield情報バリアのセグメント制限オブジェクトを作成します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエスト本文

string本文内必須
"shield_information_barrier_segment_restriction"

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

次の値に固定: shield_information_barrier_segment_restriction

object本文内

制限されたShield情報バリアのセグメントのtypeid

string本文内必須
"1910967"

制限されたShield情報バリアのセグメントのID参照。

string本文内必須
"shield_information_barrier_segment"

制限されたShield情報バリアのセグメントのタイプ。

次の値に固定: shield_information_barrier_segment

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

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

"1910967"

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

"shield_information_barrier_segment"

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

次の値に固定: shield_information_barrier_segment

レスポンス

新しく作成されたShield情報バリアのセグメント制限オブジェクトを返します。

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

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

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

リクエストの例

TypeScript Gen
await client.shieldInformationBarrierSegmentRestrictions.createShieldInformationBarrierSegmentRestriction(
  {
    restrictedSegment: {
      id: segmentToRestrictId,
      type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField,
    } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField,
    shieldInformationBarrierSegment: {
      id: segmentId,
      type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField,
    } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField,
    type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField,
  } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyInput,
);
Python Gen
client.shield_information_barrier_segment_restrictions.create_shield_information_barrier_segment_restriction(
    CreateShieldInformationBarrierSegmentRestrictionShieldInformationBarrierSegment(
        id=segment_id,
        type=CreateShieldInformationBarrierSegmentRestrictionShieldInformationBarrierSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT.value,
    ),
    CreateShieldInformationBarrierSegmentRestrictionRestrictedSegment(
        id=segment_to_restrict_id,
        type=CreateShieldInformationBarrierSegmentRestrictionRestrictedSegmentTypeField.SHIELD_INFORMATION_BARRIER_SEGMENT.value,
    ),
    type=CreateShieldInformationBarrierSegmentRestrictionType.SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION.value,
)
.NET Gen
await client.ShieldInformationBarrierSegmentRestrictions.CreateShieldInformationBarrierSegmentRestrictionAsync(requestBody: new CreateShieldInformationBarrierSegmentRestrictionRequestBody(restrictedSegment: new CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField() { Id = segmentToRestrictId, Type = CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField.ShieldInformationBarrierSegment }, shieldInformationBarrierSegment: new CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField() { Id = segmentId, Type = CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField.ShieldInformationBarrierSegment }, type: CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField.ShieldInformationBarrierSegmentRestriction));
Node
const barrierSegmentRestriction = await client.shieldInformationBarrierSegmentRestrictions.create({
	type: 'shield_information_barrier_segment_restriction',
	shield_information_barrier_segment: {
		type: 'shield_information_barrier_segment',
		id: '1910967'
	},
	restricted_segment: {
		type: 'shield_information_barrier_segment',
		id: '1910968'
	}
});
console.log(`Shield information barrier segment restriction with id ${barrierSegmentRestriction.id} was created`);

レスポンスの例

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