Jump to

• Request
• Response

Schedule Project

post

/job/schedule

Asynchronously schedules a project.

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of project objects for Schedule service

Root Schema : Schedule

Type: object

Title: Schedule

Schedule Entity

Show Source

• EPSObjectId: array EPSObjectId
• NewDataDate: string (date-time)
  The new data date.
• PortfolioObjectId: array PortfolioObjectId
• ProjectObjectId: array ProjectObjectId
  The unique identifier of the project.
• 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 you use this operation without specifying a Timeout parameter or with a Timeout of 0, the server immediately returns without waiting for the job service to complete.

{
    "title":"Schedule",
    "type":"object",
    "properties":{
        "ProjectObjectId":{
            "type":"array",
            "description":"The unique identifier of the project.",
            "items":{
                "type":"integer",
                "description":"The unique identifier of the project.",
                "format":"int32"
            }
        },
        "PortfolioObjectId":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "EPSObjectId":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "NewDataDate":{
            "type":"string",
            "description":"The new data date.",
            "format":"date-time"
        },
        "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 you use this operation 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":"Schedule Entity"
}

Nested Schema : EPSObjectId

Type: array

Show Source

• Array of: integer(int32)

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

Nested Schema : PortfolioObjectId

Type: array

Show Source

• Array of: integer(int32)

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

Nested Schema : ProjectObjectId

Type: array

The unique identifier of the project.

Show Source

• Array of: integer(int32)
  The unique identifier of the project.

{
    "type":"array",
    "description":"The unique identifier of the project.",
    "items":{
        "type":"integer",
        "description":"The unique identifier of the project.",
        "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