Skip to content

Latest commit

 

History

History
138 lines (82 loc) · 3.5 KB

archives.md

File metadata and controls

138 lines (82 loc) · 3.5 KB

ArchivesManager

List archives

Retrieves archives for an enterprise.

To learn more about the archive APIs, see the Archive API Guide.

This operation is performed by calling function getArchivesV2025R0.

See the endpoint docs at API Reference.

client.getArchives().getArchivesV2025R0(new GetArchivesV2025R0QueryParams.Builder().limit(100L).build())

Arguments

  • queryParams GetArchivesV2025R0QueryParams
    • Query parameters of getArchivesV2025R0 method
  • headers GetArchivesV2025R0Headers
    • Headers of getArchivesV2025R0 method

Returns

This function returns a value of type ArchivesV2025R0.

Returns a list of archives in the enterprise.

Create archive

Creates an archive.

To learn more about the archive APIs, see the Archive API Guide.

This operation is performed by calling function createArchiveV2025R0.

See the endpoint docs at API Reference.

client.getArchives().createArchiveV2025R0(new CreateArchiveV2025R0RequestBody.Builder(archiveName).description(archiveDescription).build())

Arguments

  • requestBody CreateArchiveV2025R0RequestBody
    • Request body of createArchiveV2025R0 method
  • headers CreateArchiveV2025R0Headers
    • Headers of createArchiveV2025R0 method

Returns

This function returns a value of type ArchiveV2025R0.

Returns a new archive object.

Delete archive

Permanently deletes an archive.

To learn more about the archive APIs, see the Archive API Guide.

This endpoint is currently unavailable. Please contact support for assistance.

This operation is performed by calling function deleteArchiveByIdV2025R0.

See the endpoint docs at API Reference.

client.getArchives().deleteArchiveByIdV2025R0(archive.getId())

Arguments

  • archiveId String
    • The ID of the archive. Example: "982312"
  • headers DeleteArchiveByIdV2025R0Headers
    • Headers of deleteArchiveByIdV2025R0 method

Returns

This function returns a value of type void.

Returns an empty response when the archive has been deleted.

Update archive

Updates an archive.

To learn more about the archive APIs, see the Archive API Guide.

This operation is performed by calling function updateArchiveByIdV2025R0.

See the endpoint docs at API Reference.

client.getArchives().updateArchiveByIdV2025R0(archive.getId(), new UpdateArchiveByIdV2025R0RequestBody.Builder().name(newArchiveName).description(newArchiveDescription).build())

Arguments

  • archiveId String
    • The ID of the archive. Example: "982312"
  • requestBody UpdateArchiveByIdV2025R0RequestBody
    • Request body of updateArchiveByIdV2025R0 method
  • headers UpdateArchiveByIdV2025R0Headers
    • Headers of updateArchiveByIdV2025R0 method

Returns

This function returns a value of type ArchiveV2025R0.

Returns the updated archive object.