Skip to content

Latest commit

 

History

History
94 lines (55 loc) · 3.18 KB

shieldinformationbarrierreports.md

File metadata and controls

94 lines (55 loc) · 3.18 KB

ShieldInformationBarrierReportsManager

List shield information barrier reports

Lists shield information barrier reports.

This operation is performed by calling function getShieldInformationBarrierReports.

See the endpoint docs at API Reference.

client.getShieldInformationBarrierReports().getShieldInformationBarrierReports(new GetShieldInformationBarrierReportsQueryParams(barrierId))

Arguments

  • queryParams GetShieldInformationBarrierReportsQueryParams
    • Query parameters of getShieldInformationBarrierReports method
  • headers GetShieldInformationBarrierReportsHeaders
    • Headers of getShieldInformationBarrierReports method

Returns

This function returns a value of type ShieldInformationBarrierReports.

Returns a paginated list of shield information barrier report objects.

Create shield information barrier report

Creates a shield information barrier report for a given barrier.

This operation is performed by calling function createShieldInformationBarrierReport.

See the endpoint docs at API Reference.

client.getShieldInformationBarrierReports().createShieldInformationBarrierReport(new ShieldInformationBarrierReference.ShieldInformationBarrierReferenceBuilder().shieldInformationBarrier(new ShieldInformationBarrierBase.ShieldInformationBarrierBaseBuilder().id(barrierId).type(ShieldInformationBarrierBaseTypeField.SHIELD_INFORMATION_BARRIER).build()).build())

Arguments

  • requestBody ShieldInformationBarrierReference
    • Request body of createShieldInformationBarrierReport method
  • headers CreateShieldInformationBarrierReportHeaders
    • Headers of createShieldInformationBarrierReport method

Returns

This function returns a value of type ShieldInformationBarrierReport.

Returns the shield information barrier report information object.

Get shield information barrier report by ID

Retrieves a shield information barrier report by its ID.

This operation is performed by calling function getShieldInformationBarrierReportById.

See the endpoint docs at API Reference.

client.getShieldInformationBarrierReports().getShieldInformationBarrierReportById(createdReport.getId())

Arguments

  • shieldInformationBarrierReportId String
    • The ID of the shield information barrier Report. Example: "3423"
  • headers GetShieldInformationBarrierReportByIdHeaders
    • Headers of getShieldInformationBarrierReportById method

Returns

This function returns a value of type ShieldInformationBarrierReport.

Returns the shield information barrier report object.