Jump to

• Request
• Response

Summarize EPS

post

/job/summarizeEPS

Asynchronously summarizes a EPS.

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of summarise EPS objects.

Root Schema : List<SummarizeEPS>

Type: array

Title: List<SummarizeEPS>

Show Source

• Array of: object SummarizeProject
  Title: SummarizeProject

  SummarizeProject Entity

{
    "title":"List<SummarizeEPS>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SummarizeEPS"
    }
}

Nested Schema : SummarizeProject

Type: object

Title: SummarizeProject

SummarizeProject Entity

Show Source

• ObjectId: integer (int32)
  The unique identifier of the EPS you want to summarize.
• Timeout: integer (int32)
  The amount of time in seconds that the server side will wait for the job service to complete before it returns with the current job status. The Timeout parameter is optional. When this operation is used without specifying a Timeout parameter or with a Timeout of 0, the server immediately returns without waiting for the job service to complete.

{
    "title":"SummarizeProject",
    "type":"object",
    "properties":{
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of the EPS you want to summarize.",
            "format":"int32"
        },
        "Timeout":{
            "type":"integer",
            "description":"The amount of time in seconds that the server side will wait for the job service to complete before it returns with the current job status. The Timeout parameter is optional. When this operation is used without specifying a Timeout parameter or with a Timeout of 0, the server immediately returns without waiting for the job service to complete.",
            "format":"int32"
        }
    },
    "description":"SummarizeProject Entity"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

OK.

Body ()

Root Schema : CreateJobServiceResponse

Type: object

Title: CreateJobServiceResponse

CreateJobServiceResponse Entity

Show Source

• JobId: string
  The unique ID of the associated job.
• JobStatus: string
  Status of the job.

{
    "title":"CreateJobServiceResponse",
    "type":"object",
    "properties":{
        "JobId":{
            "type":"string",
            "description":"The unique ID of the associated job."
        },
        "JobStatus":{
            "type":"string",
            "description":"Status of the job."
        }
    },
    "description":"CreateJobServiceResponse Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top