GET api/kdm/{fileGuid}/Status

Checks the status of an uploaded KDM or KDM Bundle.

Request Information

URI Parameters

Name	Description	Type	Additional information
fileGuid	Either the KDM Unique Identifier or the Bundle Identifier received from a succesfull bundle upload command.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

KdmUploadResult

Name	Description	Type	Additional information
FileId	The assigned unique identifier of the upload.	globally unique identifier	None.
FileCount	The number of files in the request.	integer	None.
Results	A list of upload results for each individual file uploaded.	Collection of KdmStatusResult	None.

HTTP Status Codes

Successful responses: 200 Ok

Unsuccessful responses: 401 Unauthorized

Response Formats

application/json, text/json

Samples:

{
  "FileId": "200b252a-4c0c-47fd-91f7-a6af64bd90af",
  "FileCount": 1,
  "Results": [
    {
      "Filename": "example-kdm-1.xml",
      "KdmUuid": "200b252a-4c0c-47fd-91f7-a6af64bd90af",
      "Status": "Accepted"
    }
  ]
}

{
  "FileId": "9e00b322-acc9-4db6-a379-d2f2ef03375b",
  "FileCount": 3,
  "Results": [
    {
      "Filename": "example-kdm-1.xml",
      "KdmUuid": "27117b2b-49a8-4ee4-97f3-186509a7ba5e",
      "Status": "Pending"
    },
    {
      "Filename": "example-kdm-2.xml",
      "KdmUuid": "9b509bb7-6fdf-4e16-8b42-efd12f7eaf2b",
      "Status": "Accepted"
    },
    {
      "Filename": "example-kdm-3.xml",
      "KdmUuid": "1e4a47ae-17d8-47c2-9be0-05a638d6c135",
      "Status": "Pending"
    }
  ]
}

application/xml, text/xml

Samples:

<KdmUploadResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dcip.Cloud.KeyVault.Core.Api">
  <FileCount>1</FileCount>
  <FileId>200b252a-4c0c-47fd-91f7-a6af64bd90af</FileId>
  <Results>
    <KdmStatusResult>
      <ErrorMessage i:nil="true" />
      <Filename>example-kdm-1.xml</Filename>
      <KdmUuid>200b252a-4c0c-47fd-91f7-a6af64bd90af</KdmUuid>
      <Status>Accepted</Status>
    </KdmStatusResult>
  </Results>
</KdmUploadResult>

<KdmUploadResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dcip.Cloud.KeyVault.Core.Api">
  <FileCount>3</FileCount>
  <FileId>9e00b322-acc9-4db6-a379-d2f2ef03375b</FileId>
  <Results>
    <KdmStatusResult>
      <ErrorMessage i:nil="true" />
      <Filename>example-kdm-1.xml</Filename>
      <KdmUuid>27117b2b-49a8-4ee4-97f3-186509a7ba5e</KdmUuid>
      <Status>Pending</Status>
    </KdmStatusResult>
    <KdmStatusResult>
      <ErrorMessage i:nil="true" />
      <Filename>example-kdm-2.xml</Filename>
      <KdmUuid>9b509bb7-6fdf-4e16-8b42-efd12f7eaf2b</KdmUuid>
      <Status>Accepted</Status>
    </KdmStatusResult>
    <KdmStatusResult>
      <ErrorMessage i:nil="true" />
      <Filename>example-kdm-3.xml</Filename>
      <KdmUuid>1e4a47ae-17d8-47c2-9be0-05a638d6c135</KdmUuid>
      <Status>Pending</Status>
    </KdmStatusResult>
  </Results>
</KdmUploadResult>