Jump to

• Request
• Response

Summarize Project

post

/job/summarizeProject

Asynchronously summarizes a project.

Request

Header Parameters

• Authorization:
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : SummarizeProject

Type: object

Title: SummarizeProject

SummarizeProject Entity

Show Source

• ObjectId: array ObjectId
  The unique identifier of the project you want to summarize.
• PortfolioObjectId: array PortfolioObjectId
• ProjectCodeObjectId: array ProjectCodeObjectId
• 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":"array",
            "description":"The unique identifier of the project you want to summarize.",
            "items":{
                "type":"integer",
                "description":"The unique identifier of the project you want to summarize.",
                "format":"int32"
            }
        },
        "PortfolioObjectId":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "ProjectCodeObjectId":{
            "type":"array",
            "items":{
                "type":"integer",
                "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"
}

Nested Schema : ObjectId

Type: array

The unique identifier of the project you want to summarize.

Show Source

• Array of: integer(int32)
  The unique identifier of the project you want to summarize.

{
    "type":"array",
    "description":"The unique identifier of the project you want to summarize.",
    "items":{
        "type":"integer",
        "description":"The unique identifier of the project you want to summarize.",
        "format":"int32"
    }
}

Nested Schema : PortfolioObjectId

Type: array

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : ProjectCodeObjectId

Type: array

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

OK.

Body ()

Root Schema : JobServiceResponse

Type: object

Title: JobServiceResponse

JobServiceResponse Entity

Show Source

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

{
    "title":"JobServiceResponse",
    "type":"object",
    "properties":{
        "JobId":{
            "type":"string",
            "description":"The unique ID of the associated job."
        },
        "JobStatus":{
            "type":"string",
            "description":"Status of the job."
        }
    },
    "description":"JobServiceResponse 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