Jump to

• Request
• Response

ScheduleCheck

post

/job/scheduleCheck

Starts the Check Schedule job service on a project.

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ScheduleCheck>

Type: array

Title: List<ScheduleCheck>

Show Source

• Array of: object ScheduleCheck
  Title: ScheduleCheck

  ScheduleCheck Entity

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

Nested Schema : ScheduleCheck

Type: object

Title: ScheduleCheck

ScheduleCheck Entity

Show Source

• ProjectObjectId: array ProjectObjectId
  The unique identifier of the project in P6.
• 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":"ScheduleCheck",
    "type":"object",
    "properties":{
        "ProjectObjectId":{
            "type":"array",
            "description":"The unique identifier of the project in P6.",
            "items":{
                "type":"integer",
                "description":"The unique identifier of the project in P6.",
                "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":"ScheduleCheck Entity"
}

Nested Schema : ProjectObjectId

Type: array

The unique identifier of the project in P6.

Show Source

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

{
    "type":"array",
    "description":"The unique identifier of the project in P6.",
    "items":{
        "type":"integer",
        "description":"The unique identifier of the project in P6.",
        "format":"int32"
    }
}

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