Box Developer Documentation
 
    Latest version

    Create shield information barrier report

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

    This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

    Creates a shield information barrier report for a given barrier.

    Request

    bearer [ACCESS_TOKEN]
    application/json

    Request Body

    A base representation of a shield information barrier object

    Response

    Returns the shield information barrier report information object.

    application/jsonClient error

    Returns a not_found error if the shield information barrier report was not found.

    application/jsonClient error

    Returns a conflict error if a shield information barrier report is currently being created.

    application/jsonClient error

    An unexpected client error.

    post
    Create shield information barrier report
    You can now try out some of our APIs live, right here in the documentation.
    Log in

    Request Example

    TypeScript Gen
    await client.shieldInformationBarrierReports.createShieldInformationBarrierReport(
      {
        shieldInformationBarrier: {
          id: barrierId,
          type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField,
        } satisfies ShieldInformationBarrierBase,
      } satisfies ShieldInformationBarrierReference,
    );

    Response Example

    {
      "id": "11446498",
      "type": "shield_information_barrier_report",
      "created_at": "2020-06-26T18:44:45.869Z",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "details": {
        "details": {
          "folder_id": "124235"
        }
      },
      "shield_information_barrier": {
        "shield_information_barrier": {
          "id": "11446498",
          "type": "shield_information_barrier"
        }
      },
      "status": "pending",
      "updated_at": "2020-07-26T18:44:45.869Z"
    }