Application Programming Interface Guide > Web Services Operations > Operations Reference > getArchiveContents
 
getArchiveContents
Get the contents of the archive. The contents contains an explicit list of everything that exists within the archive.
Use this operation with either an export or import archive. Use it anytime after createExportArchive or createImportArchive is called, as long as it is within the same transaction and the archive has not been closed.
Location
/services/webservices/system/admin/archive/operations/
Request Elements
archiveId: The ID of the archive whose contents to retrieve.
Response Elements
contents: The contents of the archive.
resources (optional): List of resources within the archive.
users (optional): An explicit list of domains, users, and groups within this archive. This is similar to Users Element, but some elements are illegal, as marked below.
all (illegal): This element is never set in this context.
domains (optional): List of domains included within the archive.
all (illegal): This element is never set in this context.
domains: A space-delimited list of domain names of the domains.
users (optional): List of users within the archive.
domain (0 or more): A domain that contains users within the archive.
  all (illegal): This element is never set in this context.
  name: The name of the domain containing the users.
  users (optional): A space-delimited list of user names of the users within the archive.
groups (optional): List of groups within the archive. Includes user membership.
domain (0 or more): A domain that contains groups within the archive.
  name: The name of the domain containing the groups.
  all (illegal): This element is never set in this context.
  groups (optional): List of groups and their definitions within the archive.
    name: The name of the group.
    all (illegal): This element is never set in this context.
    user (optional): List of users to be listed as members of the group.
serverAttributes (optional): A space-delimited list of server attributes (name elements) within the archive.
exportOptions (options): A space-delimited list of options (name elements) used to export additional data into the archive.
Faults
NotFound: If the archiveId does not exist. This can occur if:
the archive was previously canceled using this procedure
the getExportData returned the last chunk of data
getImportReport or performImportArchive previously returned a FAIL or SUCCESS status
this operation is called on a different transaction