You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

This page serves as an area to collocate the documentation on any REST endpoints that the OODT infrastructure exposes.

Suggestion to update documentation. Let me know if you like the format and I'll do it for the rest of the ones listed above.

Slice a job processing status by state


Endpoint:

http://host/pcs-services/services/health/report/jobs/{state}

HTTP Request

Method: GET
Parameters:

Name

Placement

Type

Description

state

path

Enum

Values range from "STARTED", "FINISHED", "PAUSED", "RSUBMIT", "QUEUED". There may be extended states but these are a list of the basic ones. Extended ones would be passed in the same manner.

HTTP Response

Valid

Status: 200 OK

JSON

{
   "report":{
      "generated":"2011-02-15T08:09:24.225-0800",
      "jobHealth":[
         {
            "state":"QUEUED",
            "numJobs":0
         }
      ]
   }
}

Example(s):

To display the number of jobs that are in the QUEUED state

http://host/pcs-services/services/health/report/jobs/QUEUED
  • No labels