Enrollment File Status

This operation retrieves the status all policies and policy update requests related to the enrollment file, to provide an overview of the progress of the file as a whole

This operation is available on any enrollment file.

Resource Representation

Resource representation of an enrollment file:

{
  ... enrollment file properties ...
  "links": [
    {
      "href": "http://<host>:<port>/[api-context-root]/generic/enrollmentfiles/<id>",
      "rel": "self"
    },
    {
      "href": "http://<host>:<port>/[api-context-root]/enrollmentfiles/<id>/status",
      "rel": "enrollmentfile:status"
      "httpMethod": "GET"
    }
  ]
}

Status Operation

The status operation returns a list of items. Each item specifies a status and the number of policy update requests that are in that status.

Consider the following example response:

{
   "items": [
      {
        "status": "Loaded",
        "count": 34
      },
      {
        "status": "Pending enrollment review",
        "count": 14
      },
      {
        "status": "Pending file review",
        "count": 9678
      },
      {
        "status": "Failed to load",
        "count": 2
      }
    ],
    "links": {
      "link": [
        {
          "httpMethod": "GET",
          "rel": "self",
          "href": "http://<host>:<port>/[api-context-root]/enrollmentfiles/<id>/status"

        }
      ]
    }
  }
}

The counts are on the number of policy update requests that are linked to the enrollment file.

These statuses can be returned:

Table 1. Enrollment File Status

Status	Description
Queued	The count of policy update requests in status QUEUED
Failed to load	The count of policy update requests in status FAILED
Loaded	The count of policy update requests in status LOADED, for which the linked policy is in status EDIT and does not have any fatal messages or technical errors.
Processing	The count of policy update requests in status LOADED, for which the linked policy is in status IN PROCESS
Failed to process	The count of policy update requests in status LOADED, for which the linked policy is in status EDIT and has a technical error
Rule Violation	The count of policy update requests in status LOADED, for which the linked policy is in status EDIT and has at least one fatal message.
Processed	The count of policy update requests in status PROCESSED
Processed no change	The count of policy update requests in status PROCESSED NO CHANGE
Pending enrollment review	The count of policy update requests in status LOADED, for which the linked policy is in status PENDED
Pending file review	The count of policy update requests in status LOADED, for which the linked policy is in status PENDING FILE REVIEW
Rejected	The count of policy update requests in status REJECTED

Authorization

The above described operation is protected by access restriction enrollment file statuses IP.