Jump to

• Request
• Response

Read ScheduleCheckOption

get

/scheduleCheckOption

Reads ScheduleCheckOption objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<ScheduleCheckOption>

Type: array

Title: List<ScheduleCheckOption>

Show Source

• Array of: object ScheduleCheckOption
  Title: ScheduleCheckOption

  ScheduleCheckOption Entity

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

Nested Schema : ScheduleCheckOption

Type: object

Title: ScheduleCheckOption

ScheduleCheckOption Entity

Show Source

• BEITripwireTarget: number (double)
  The baseline execution index.
• CheckBEITripwire: boolean
  The baseline execution index.
• CheckHardConstraints: boolean
  Checks for the constraints that prevent activities from being moved.
• CheckInvalidProgress: boolean
  Checks for activities that have invalid progress dates.
• CheckLags: boolean
  Checks for relationships that have a positive lag duration.
• CheckLargeDurations: boolean
  Checks for activities that have a remaining duration that is greater than the specified LargeDurationCriteria value..
• CheckLargeFloat: boolean
  Checks for activities that have a float value greater than the specified LargeFloatCriteria value.
• CheckLateActivities: boolean
  Checks for activities that are scheduled to finish later than the project baseline.
• CheckLogic: boolean
  Checks for activities with missing predecessors or successors.
• CheckLongLags: boolean
  Checks for relationships that have a lag duration that is greater than the specified LongLagsCriteria value.
• CheckNegativeFloat: boolean
  Checks for activities that have a total float less than 0.
• CheckNegativeLags: boolean
  Checks for relationships that have a lag duration less than 0.
• CheckRelationShips: boolean
  Checks for the relationships that are set
• CheckResources: boolean
  Checks for activities that do not have an expense or an assigned resource.
• CheckSoftConstraints: boolean
  Checks for constraints that do not prevent activities from being moved.
• HardConstraintTarget: integer (int32)
  Checks for constraints that prevent activities from being moved.
• LagsTarget: integer (int32)
  Relationships that have a positive lag duration.
• LargeDurationCriteria: integer (int32)
  The value of the Large Duration Criteria.
• LargeDurationTarget: integer (int32)
  Activities that have a remaining duration greater than the Large Duration Criteria.
• LargeFloatCriteria: integer (int32)
  The value of the Large Float Criteria.
• LargeFloatTarget: integer (int32)
  Activities that have a total float greater than the Large Float Criteria.
• LateActivitiesTarget: integer (int32)
  Activities that are scheduled to finish later than the project baseline.
• LogicTarget: integer (int32)
  Activities that are missing predecessors or successors.
• LongLagsCriteria: integer (int32)
  The value of the Long Lags Criteria.
• LongLagsTarget: integer (int32)
  Relationships that have a lag duration greater than the Long Lags Criteria.
• NegativeFloatTarget: integer (int32)
  Activities that have a total float less than 0.
• NegativeLagsTarget: integer (int32)
  Relationships that have a lag duration less than 0.
• ProgressDateTarget: integer (int32)
  Activities that have invalid progress dates.
• ProjectObjectId: integer (int32)
  The unique identifier of the project which has a schedule you want to check.
• ProjPropTypeInt: integer (int32)
  The enum values that are associated with the Project Property Type.
• PropValue: string
  The Project Property Type value.
• RelationshipTarget: integer (int32)
  The relationships that are finish to start.
• ResourcesTarget: integer (int32)
  Activities that do not have an expense or an assigned resource.
• ScheduleCheckData: string
  The ScheduleCheck data.
• ScheduleCheckOptionsId: integer (int32)
  The unique id for ScheduleCheckOptions.
• SoftConstraintTarget: integer (int32)
  Constraints that do not prevent activities from being moved.

{
    "title":"ScheduleCheckOption",
    "type":"object",
    "properties":{
        "CheckBEITripwire":{
            "type":"boolean",
            "description":"The baseline execution index."
        },
        "CheckHardConstraints":{
            "type":"boolean",
            "description":"Checks for the constraints that prevent activities from being moved."
        },
        "CheckInvalidProgress":{
            "type":"boolean",
            "description":"Checks for activities that have invalid progress dates."
        },
        "CheckLags":{
            "type":"boolean",
            "description":"Checks for relationships that have a positive lag duration."
        },
        "CheckLargeDurations":{
            "type":"boolean",
            "description":"Checks for activities that have a remaining duration that is greater than the specified LargeDurationCriteria value.."
        },
        "CheckLargeFloat":{
            "type":"boolean",
            "description":"Checks for activities that have a float value greater than the specified LargeFloatCriteria value."
        },
        "CheckLateActivities":{
            "type":"boolean",
            "description":"Checks for activities that are scheduled to finish later than the project baseline."
        },
        "CheckLogic":{
            "type":"boolean",
            "description":"Checks for activities with missing predecessors or successors."
        },
        "CheckLongLags":{
            "type":"boolean",
            "description":"Checks for relationships that have a lag duration that is greater than the specified LongLagsCriteria value."
        },
        "CheckNegativeFloat":{
            "type":"boolean",
            "description":"Checks for activities that have a total float less than 0."
        },
        "CheckNegativeLags":{
            "type":"boolean",
            "description":"Checks for relationships that have a lag duration less than 0."
        },
        "CheckRelationShips":{
            "type":"boolean",
            "description":"Checks for the relationships that are set"
        },
        "CheckResources":{
            "type":"boolean",
            "description":"Checks for activities that do not have an expense or an assigned resource."
        },
        "CheckSoftConstraints":{
            "type":"boolean",
            "description":"Checks for constraints that do not prevent activities from being moved."
        },
        "HardConstraintTarget":{
            "type":"integer",
            "description":"Checks for constraints that prevent activities from being moved.",
            "format":"int32"
        },
        "LagsTarget":{
            "type":"integer",
            "description":"Relationships that have a positive lag duration.",
            "format":"int32"
        },
        "LargeDurationCriteria":{
            "type":"integer",
            "description":"The value of the Large Duration Criteria.",
            "format":"int32"
        },
        "LargeDurationTarget":{
            "type":"integer",
            "description":"Activities that have a remaining duration greater than the Large Duration Criteria.",
            "format":"int32"
        },
        "LargeFloatCriteria":{
            "type":"integer",
            "description":"The value of the Large Float Criteria.",
            "format":"int32"
        },
        "LargeFloatTarget":{
            "type":"integer",
            "description":"Activities that have a total float greater than the Large Float Criteria.",
            "format":"int32"
        },
        "LateActivitiesTarget":{
            "type":"integer",
            "description":"Activities that are scheduled to finish later than the project baseline.",
            "format":"int32"
        },
        "LogicTarget":{
            "type":"integer",
            "description":"Activities that are missing predecessors or successors.",
            "format":"int32"
        },
        "LongLagsCriteria":{
            "type":"integer",
            "description":"The value of the Long Lags Criteria.",
            "format":"int32"
        },
        "LongLagsTarget":{
            "type":"integer",
            "description":"Relationships that have a lag duration greater than the Long Lags Criteria.",
            "format":"int32"
        },
        "NegativeFloatTarget":{
            "type":"integer",
            "description":"Activities that have a total float less than 0.",
            "format":"int32"
        },
        "NegativeLagsTarget":{
            "type":"integer",
            "description":"Relationships that have a lag duration less than 0.",
            "format":"int32"
        },
        "ProgressDateTarget":{
            "type":"integer",
            "description":"Activities that have invalid progress dates.",
            "format":"int32"
        },
        "ProjPropTypeInt":{
            "type":"integer",
            "description":"The enum values that are associated with the Project Property Type.",
            "format":"int32"
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique identifier of the project which has a schedule you want to check.",
            "format":"int32"
        },
        "PropValue":{
            "type":"string",
            "description":"The Project Property Type value."
        },
        "RelationshipTarget":{
            "type":"integer",
            "description":"The relationships that are finish to start.",
            "format":"int32"
        },
        "ResourcesTarget":{
            "type":"integer",
            "description":"Activities that do not have an expense or an assigned resource.",
            "format":"int32"
        },
        "ScheduleCheckData":{
            "type":"string",
            "description":"The ScheduleCheck data."
        },
        "ScheduleCheckOptionsId":{
            "type":"integer",
            "description":"The unique id for ScheduleCheckOptions.",
            "format":"int32"
        },
        "SoftConstraintTarget":{
            "type":"integer",
            "description":"Constraints that do not prevent activities from being moved.",
            "format":"int32"
        },
        "BEITripwireTarget":{
            "type":"number",
            "description":"The baseline execution index.",
            "format":"double"
        }
    },
    "description":"ScheduleCheckOption 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