Create Task Query Filter - Schedules

Task Actual Duration filter field.

taskActualPhysicalQuantity

Task Actual Physical Quantity filter field.

taskConstraintEarlyDate

Task Constraint Early Date filter field.

taskConstraintLateDate

Task Constraint Late Date filter field.

taskConstraintType

TaskConstraintTypeFilterField, null

Task Constraint Type filter field.

taskDurationType

TaskDurationTypeFilterField, null

Task Duration filter field.

taskEstimatedRate

Task Estimated Rate filter field.

taskExpectedFinish

Task Expected Finish filter field.

taskIsWbs

BooleanFilterField, null

Task Is WBS filter field.

taskName

Task Name filter field.

taskPercentComplete

Task Percent Complete filter field.

taskPhysicalQuantityUnit

ResourceUnitTypeFilterField, null

Task Physical Quantity Unit filter field.

taskPlannedDuration

Task Planned Duration filter field.

taskPlannedPhysicalQuantity

Task Planned Physical Quantity filter field.

taskProgressType

TaskProgressTypeFilterField, null

Task Progress Type filter field.

taskRemainingDuration

Task Remaining Duration filter field.

taskRemainingPhysicalQuantity

Task Remaining Physical Quantity filter field.

taskStatus

TaskStatusTypeFilterField, null

Task Status filter field.

taskType

TaskTypeFilterField, null

Task Type filter field.

taskUrl

Task URL filter field.

taskUserDefinedId

Task User Defined ID filter field.

version

Int32

The version of the Task Query Filter.

Example

json

{
    "id": "bfe4d22d-027c-45d4-b3cc-50ecfa4b1bd7",
    "isShared": true,
    "name": "Nearly completed work",
    "taskName": {
        "operation": "EndsWith",
        "values": [
            "TaskSuffix"
        ]
    },
    "taskPercentComplete": {
        "operation": "MoreOrEqual",
        "values": [
            90
        ]
    },
    "taskType": {
        "operation": "Equals",
        "values": [
            "Work"
        ]
    },
    "version": 1
}

Response 201 Created

Created

json

{
    "taskQueryFilter": {
        "createdBy": "ca76991e-3b1a-4c9a-9b90-e4fcf7beec52",
        "deleted": false,
        "id": "bfe4d22d-027c-45d4-b3cc-50ecfa4b1bd7",
        "isShared": true,
        "name": "Nearly completed work",
        "taskActualDuration": null,
        "taskActualPhysicalQuantity": null,
        "taskConstraintEarlyDate": null,
        "taskConstraintLateDate": null,
        "taskConstraintType": null,
        "taskDurationType": null,
        "taskEstimatedRate": null,
        "taskExpectedFinish": null,
        "taskIsWbs": null,
        "taskName": null,
        "taskPercentComplete": {
            "operation": "MoreOrEqual",
            "values": [
                90
            ]
        },
        "taskPhysicalQuantityUnit": null,
        "taskPlannedDuration": null,
        "taskPlannedPhysicalQuantity": null,
        "taskRemainingPhysicalQuantity": null,
        "taskStatus": null,
        "taskType": {
            "operation": "Equals",
            "values": [
                "Work"
            ]
        },
        "taskUrl": null,
        "taskUserDefinedId": null,
        "version": 1
    }
}

Response headers

Location

A header that identifies the location of a specific resource. For more information see the official documentation.

Response 400 Bad Request

The 400 (Bad Request) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidSchedulesRequest",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "A required property is missing or empty.",
                "target": "name"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A required property is missing or empty.",
                "target": "version"
            },
            {
                "code": "InvalidProperty",
                "message": "The 'values' property must not contain more than 200 items.",
                "target": "taskPercentComplete.values"
            },
            {
                "code": "InvalidProperty",
                "message": "The 'values' property must not be empty.",
                "target": "taskName.values"
            }
        ],
        "message": "The request contains invalid properties."
    }
}

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

This response indicates that the provided Schedule is not available.

json

{
    "error": {
        "code": "ScheduleNotFound",
        "message": "Requested Schedule is not available.",
        "target": "scheduleId"
    }
}

Response 409 Conflict

Indicates that the entity being created conflicts with an existing one.

json

{
    "error": {
        "code": "TaskQueryFilterExists",
        "message": "Task Query Filter with provided Id already exists."
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Boolean Filter Field

Representation of a filter field for boolean values.

operation

Value matching operation for filtering.

values

Boolean[]

Boolean values to filter by.

json

{
    "title": "Boolean Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterEnumOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "type": "boolean"
            },
            "description": "Boolean values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for boolean values."
}

Date Time Filter Field

Representation of a filter field for datetime values.

operation

FilterNumberOperation

Value matching operation for filtering.

values

String[]

Date Time values to filter by.

json

{
    "title": "Date Time Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterNumberOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "type": "string",
                "format": "date-time"
            },
            "description": "Date Time values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for datetime values."
}

Double Filter Field

Representation of a filter field for double numeric values.

operation

FilterNumberOperation

Value matching operation for filtering.

values

Number[]

Double numeric values to filter by.

json

{
    "title": "Double Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterNumberOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "type": "number",
                "format": "double"
            },
            "description": "Double numeric values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for double numeric values."
}

Filter Enum Operation

Defines the type of enum matching operation for filtering. The match succeeds if a value matches any of the provided filter values.

Equals

String

NotEquals

String

json

{
    "title": "Filter Enum Operation",
    "enum": [
        "Equals",
        "NotEquals"
    ],
    "type": "string",
    "description": "Defines the type of enum matching operation for filtering. The match succeeds if a value matches any of the provided filter values."
}

Filter Number Operation

Defines the type of number matching operation for filtering. The match succeeds if a value matches any of the provided filter values. Note that only the Equals operation makes sense if providing multiple filter values.

Equals

String

NotEquals

String

Less

String

MoreOrEqual

String

LessOrEqual

String

json

{
    "title": "Filter Number Operation",
    "enum": [
        "Equals",
        "NotEquals",
        "More",
        "Less",
        "MoreOrEqual",
        "LessOrEqual"
    ],
    "type": "string",
    "description": "Defines the type of number matching operation for filtering. The match succeeds if a value matches any of the provided filter values. Note that only the Equals operation makes sense if providing multiple filter values."
}

Filter Text Operation

Defines the type of text matching operation for filtering. The match succeeds if a value matches any of the provided filter values.

Equals

String

NotEquals

String

Contains

String

StartsWith

String

EndsWith

String

NotContains

String

NotStartsWith

String

NotEndsWith

String

ContainsCaseInsensitive

String

StartsWithCaseInsensitive

String

EndsWithCaseInsensitive

String

EqualsCaseInsensitive

String

NotEqualsCaseInsensitive

String

NotContainsCaseInsensitive

String

NotStartsWithCaseInsensitive

String

NotEndsWithCaseInsensitive

String

json

{
    "title": "Filter Text Operation",
    "enum": [
        "Equals",
        "NotEquals",
        "Contains",
        "StartsWith",
        "EndsWith",
        "NotContains",
        "NotStartsWith",
        "NotEndsWith",
        "ContainsCaseInsensitive",
        "StartsWithCaseInsensitive",
        "EndsWithCaseInsensitive",
        "EqualsCaseInsensitive",
        "NotEqualsCaseInsensitive",
        "NotContainsCaseInsensitive",
        "NotStartsWithCaseInsensitive",
        "NotEndsWithCaseInsensitive"
    ],
    "type": "string",
    "description": "Defines the type of text matching operation for filtering. The match succeeds if a value matches any of the provided filter values."
}

Int32 Filter Field

Representation of a filter field for int32 numeric values.

operation

FilterNumberOperation

Value matching operation for filtering.

values

Integer[]

Int32 numeric values to filter by.

json

{
    "title": "Int32 Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterNumberOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "type": "integer",
                "format": "int32"
            },
            "description": "Int32 numeric values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for int32 numeric values."
}

Resource Unit Type

The possible unit types for resources.

CubicFeet

String

CubicMeter

String

Liter

String

Millimeter

String

Meter

String

Feet

String

Each

String

Pair

String

Dozen

String

Gross

String

SqFoot

String

SqYard

String

SqMeter

String

Pound

String

Gram

String

Kilo

String

Bag

String

Box

String

Bucket

String

Bundle

String

Card

String

Carton

String

Coil

String

Pack

String

Pegs

String

Length

String

Outer

String

Pallet

String

Roll

String

Sachet

String

Set

String

Sheet

String

Ton

String

Person

String

Item

String

CubicYard

String

MetricTon

String

Hour

String

LinearMeter

String

Unknown

String

json

{
    "title": "Resource Unit Type",
    "enum": [
        "CubicFeet",
        "CubicMeter",
        "Liter",
        "Millimeter",
        "Meter",
        "Feet",
        "Each",
        "Pair",
        "Dozen",
        "Gross",
        "SqFoot",
        "SqYard",
        "SqMeter",
        "Pound",
        "Gram",
        "Kilo",
        "Bag",
        "Box",
        "Bucket",
        "Bundle",
        "Card",
        "Carton",
        "Coil",
        "Pack",
        "Pegs",
        "Length",
        "Outer",
        "Pallet",
        "Roll",
        "Sachet",
        "Set",
        "Sheet",
        "Ton",
        "Person",
        "Item",
        "CubicYard",
        "MetricTon",
        "Hour",
        "LinearMeter",
        "Unknown"
    ],
    "type": "string",
    "description": "The possible unit types for resources."
}

Resource Unit Type Filter Field

Representation of a filter field for Resource Unit Type enum values.

operation

Value matching operation for filtering.

values

ResourceUnitType[]

Resource Unit Type enum values to filter by.

json

{
    "title": "Resource Unit Type Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterEnumOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ResourceUnitType"
            },
            "description": "Resource Unit Type enum values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for Resource Unit Type enum values."
}

String Filter Field

Representation of a filter field for string values.

operation

FilterTextOperation

Value matching operation for filtering.

values

String[]

String values to filter by.

json

{
    "title": "String Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterTextOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "String values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for string values."
}

Task Constraint Type

Task Constraints determine the rules under which a Task can be started and rescheduled. See the Task Constraint Types section for details.

NoConstraint

String

CannotReschedule

String

StartAsap

String

StartAlap

String

StartOn

String

StartAfter

String

StartBefore

String

StartBetween

String

FinishOn

String

FinishAfter

String

FinishBefore

String

FinishBetween

String

MandatoryStart

String

MandatoryFinish

String

WorkBetween

String

WorkOut

String

Unknown

String

json

{
    "title": "Task Constraint Type",
    "enum": [
        "NoConstraint",
        "CannotReschedule",
        "StartAsap",
        "StartAlap",
        "StartOn",
        "StartAfter",
        "StartBefore",
        "StartBetween",
        "FinishOn",
        "FinishAfter",
        "FinishBefore",
        "FinishBetween",
        "MandatoryStart",
        "MandatoryFinish",
        "WorkBetween",
        "WorkOut",
        "Unknown"
    ],
    "type": "string",
    "description": "Task Constraints determine the rules under which a Task can be started and rescheduled. See the [Task Constraint Types](#task-constraint-types) section for details."
}

Task Constraint Type Filter Field

Representation of a filter field for Task Constraint Type enum values.

operation

Value matching operation for filtering.

values

TaskConstraintType[]

Task Constraint Type enum values to filter by.

json

{
    "title": "Task Constraint Type Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterEnumOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskConstraintType"
            },
            "description": "Task Constraint Type enum values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for Task Constraint Type enum values."
}

Task Duration Type

The Task duration type value specifies way that Task Duration is determined. See the Task Duration Types section for details.

Fixed

String

PhysicalQuantityDependent

String

ResourceUnitsDependent

String

Unknown

String

json

{
    "title": "Task Duration Type",
    "enum": [
        "Fixed",
        "PhysicalQuantityDependent",
        "ResourceUnitsDependent",
        "Unknown"
    ],
    "type": "string",
    "description": "The Task duration type value specifies way that Task Duration is determined. See the [Task Duration Types](#task-duration-types) section for details."
}

Task Duration Type Filter Field

Representation of a filter field for Task Duration Type enum values.

operation

Value matching operation for filtering.

values

TaskDurationType[]

Task Duration Type enum values to filter by.

json

{
    "title": "Task Duration Type Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterEnumOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskDurationType"
            },
            "description": "Task Duration Type enum values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for Task Duration Type enum values."
}

Task Progress Type

The Task progress type value specifies way that Task Progress is determined. See the Task Progress Types section for details.

Automatic

String

Manual

String

Duration

String

Physical

String

Unit

String

Unknown

String

json

{
    "title": "Task Progress Type",
    "enum": [
        "Automatic",
        "Manual",
        "Duration",
        "Physical",
        "Unit",
        "Unknown"
    ],
    "type": "string",
    "description": "The Task progress type value specifies way that Task Progress is determined. See the [Task Progress Types](#task-progress-types) section for details."
}

Task Progress Type Filter Field

Representation of a filter field for Task Progress Type enum values.

operation

Value matching operation for filtering.

values

TaskProgressType[]

Task Progress Type enum values to filter by.

json

{
    "title": "Task Progress Type Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterEnumOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskProgressType"
            },
            "description": "Task Progress Type enum values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for Task Progress Type enum values."
}

Task Query Filter

Representation of a filtered task query. The returned tasks will match all applied filters.

createdBy

String

The unique identifier of who created this Task Query Filter.

deleted

Boolean

Is this Task Query Filter deleted.

String

The unique identifier of the Task Query Filter.

isShared

Boolean

Is this Task Query Filter shared.

name

String, null

The name of the Task Query Filter.

taskActualDuration

Task Actual Duration filter field.

taskActualPhysicalQuantity

Task Actual Physical Quantity filter field.

taskConstraintEarlyDate

Task Constraint Early Date filter field.

taskConstraintLateDate

Task Constraint Late Date filter field.

taskConstraintType

TaskConstraintTypeFilterField, null

Task Constraint Type filter field.

taskDurationType

TaskDurationTypeFilterField, null

Task Duration filter field.

taskEstimatedRate

Task Estimated Rate filter field.

taskExpectedFinish

Task Expected Finish filter field.

taskIsWbs

BooleanFilterField, null

Task Is WBS filter field.

taskName

Task Name filter field.

taskPercentComplete

Task Percent Complete filter field.

taskPhysicalQuantityUnit

ResourceUnitTypeFilterField, null

Task Physical Quantity Unit filter field.

taskPlannedDuration

Task Planned Duration filter field.

taskPlannedPhysicalQuantity

Task Planned Physical Quantity filter field.

taskProgressType

TaskProgressTypeFilterField, null

Task Progress Type filter field.

taskRemainingDuration

Task Remaining Duration filter field.

taskRemainingPhysicalQuantity

Task Remaining Physical Quantity filter field.

taskStatus

TaskStatusTypeFilterField, null

Task Status filter field.

taskType

TaskTypeFilterField, null

Task Type filter field.

taskUrl

Task URL filter field.

taskUserDefinedId

Task User Defined ID filter field.

version

Int32

The version of the Task Query Filter.

json

{
    "title": "Task Query Filter",
    "type": "object",
    "properties": {
        "createdBy": {
            "type": "string",
            "description": "The unique identifier of who created this Task Query Filter."
        },
        "deleted": {
            "type": "boolean",
            "description": "Is this Task Query Filter deleted."
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Task Query Filter."
        },
        "isShared": {
            "type": "boolean",
            "description": "Is this Task Query Filter shared."
        },
        "name": {
            "type": "string",
            "description": "The name of the Task Query Filter.",
            "nullable": true
        },
        "taskActualDuration": {
            "$ref": "#/components/schemas/Int32FilterField",
            "description": "Task Actual Duration filter field.",
            "nullable": true
        },
        "taskActualPhysicalQuantity": {
            "$ref": "#/components/schemas/DoubleFilterField",
            "description": "Task Actual Physical Quantity filter field.",
            "nullable": true
        },
        "taskConstraintEarlyDate": {
            "$ref": "#/components/schemas/DateTimeFilterField",
            "description": "Task Constraint Early Date filter field.",
            "nullable": true
        },
        "taskConstraintLateDate": {
            "$ref": "#/components/schemas/DateTimeFilterField",
            "description": "Task Constraint Late Date filter field.",
            "nullable": true
        },
        "taskConstraintType": {
            "$ref": "#/components/schemas/TaskConstraintTypeFilterField",
            "description": "Task Constraint Type filter field.",
            "nullable": true
        },
        "taskDurationType": {
            "$ref": "#/components/schemas/TaskDurationTypeFilterField",
            "description": "Task Duration filter field.",
            "nullable": true
        },
        "taskEstimatedRate": {
            "$ref": "#/components/schemas/DoubleFilterField",
            "description": "Task Estimated Rate filter field.",
            "nullable": true
        },
        "taskExpectedFinish": {
            "$ref": "#/components/schemas/DateTimeFilterField",
            "description": "Task Expected Finish filter field.",
            "nullable": true
        },
        "taskIsWbs": {
            "$ref": "#/components/schemas/BooleanFilterField",
            "description": "Task Is WBS filter field.",
            "nullable": true
        },
        "taskName": {
            "$ref": "#/components/schemas/StringFilterField",
            "description": "Task Name filter field.",
            "nullable": true
        },
        "taskPercentComplete": {
            "$ref": "#/components/schemas/Int32FilterField",
            "description": "Task Percent Complete filter field.",
            "nullable": true
        },
        "taskPhysicalQuantityUnit": {
            "$ref": "#/components/schemas/ResourceUnitTypeFilterField",
            "description": "Task Physical Quantity Unit filter field.",
            "nullable": true
        },
        "taskPlannedDuration": {
            "$ref": "#/components/schemas/Int32FilterField",
            "description": "Task Planned Duration filter field.",
            "nullable": true
        },
        "taskPlannedPhysicalQuantity": {
            "$ref": "#/components/schemas/DoubleFilterField",
            "description": "Task Planned Physical Quantity filter field.",
            "nullable": true
        },
        "taskProgressType": {
            "$ref": "#/components/schemas/TaskProgressTypeFilterField",
            "description": "Task Progress Type filter field.",
            "nullable": true
        },
        "taskRemainingDuration": {
            "$ref": "#/components/schemas/Int32FilterField",
            "description": "Task Remaining Duration filter field.",
            "nullable": true
        },
        "taskRemainingPhysicalQuantity": {
            "$ref": "#/components/schemas/DoubleFilterField",
            "description": "Task Remaining Physical Quantity filter field.",
            "nullable": true
        },
        "taskStatus": {
            "$ref": "#/components/schemas/TaskStatusTypeFilterField",
            "description": "Task Status filter field.",
            "nullable": true
        },
        "taskType": {
            "$ref": "#/components/schemas/TaskTypeFilterField",
            "description": "Task Type filter field.",
            "nullable": true
        },
        "taskUrl": {
            "$ref": "#/components/schemas/StringFilterField",
            "description": "Task URL filter field.",
            "nullable": true
        },
        "taskUserDefinedId": {
            "$ref": "#/components/schemas/StringFilterField",
            "description": "Task User Defined ID filter field.",
            "nullable": true
        },
        "version": {
            "type": "integer",
            "description": "The version of the Task Query Filter.",
            "format": "int32"
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filtered task query. The returned tasks will match all applied filters."
}

Task Query Filter Create Request

Properties of the Task Query Filter to be created.

String

The unique identifier of the Task Query Filter.

isShared

Boolean

Is this Task Query Filter shared.

name

String

The name of the Task Query Filter.

taskActualDuration

Task Actual Duration filter field.

taskActualPhysicalQuantity

Task Actual Physical Quantity filter field.

taskConstraintEarlyDate

Task Constraint Early Date filter field.

taskConstraintLateDate

Task Constraint Late Date filter field.

taskConstraintType

TaskConstraintTypeFilterField, null

Task Constraint Type filter field.

taskDurationType

TaskDurationTypeFilterField, null

Task Duration filter field.

taskEstimatedRate

Task Estimated Rate filter field.

taskExpectedFinish

Task Expected Finish filter field.

taskIsWbs

BooleanFilterField, null

Task Is WBS filter field.

taskName

Task Name filter field.

taskPercentComplete

Task Percent Complete filter field.

taskPhysicalQuantityUnit

ResourceUnitTypeFilterField, null

Task Physical Quantity Unit filter field.

taskPlannedDuration

Task Planned Duration filter field.

taskPlannedPhysicalQuantity

Task Planned Physical Quantity filter field.

taskProgressType

TaskProgressTypeFilterField, null

Task Progress Type filter field.

taskRemainingDuration

Task Remaining Duration filter field.

taskRemainingPhysicalQuantity

Task Remaining Physical Quantity filter field.

taskStatus

TaskStatusTypeFilterField, null

Task Status filter field.

taskType

TaskTypeFilterField, null

Task Type filter field.

taskUrl

Task URL filter field.

taskUserDefinedId

Task User Defined ID filter field.

version

Int32

The version of the Task Query Filter.

json

{
    "title": "Task Query Filter Create Request",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Task Query Filter."
        },
        "isShared": {
            "type": "boolean",
            "description": "Is this Task Query Filter shared."
        },
        "name": {
            "minLength": 1,
            "type": "string",
            "description": "The name of the Task Query Filter."
        },
        "taskActualDuration": {
            "$ref": "#/components/schemas/Int32FilterField",
            "description": "Task Actual Duration filter field.",
            "nullable": true
        },
        "taskActualPhysicalQuantity": {
            "$ref": "#/components/schemas/DoubleFilterField",
            "description": "Task Actual Physical Quantity filter field.",
            "nullable": true
        },
        "taskConstraintEarlyDate": {
            "$ref": "#/components/schemas/DateTimeFilterField",
            "description": "Task Constraint Early Date filter field.",
            "nullable": true
        },
        "taskConstraintLateDate": {
            "$ref": "#/components/schemas/DateTimeFilterField",
            "description": "Task Constraint Late Date filter field.",
            "nullable": true
        },
        "taskConstraintType": {
            "$ref": "#/components/schemas/TaskConstraintTypeFilterField",
            "description": "Task Constraint Type filter field.",
            "nullable": true
        },
        "taskDurationType": {
            "$ref": "#/components/schemas/TaskDurationTypeFilterField",
            "description": "Task Duration filter field.",
            "nullable": true
        },
        "taskEstimatedRate": {
            "$ref": "#/components/schemas/DoubleFilterField",
            "description": "Task Estimated Rate filter field.",
            "nullable": true
        },
        "taskExpectedFinish": {
            "$ref": "#/components/schemas/DateTimeFilterField",
            "description": "Task Expected Finish filter field.",
            "nullable": true
        },
        "taskIsWbs": {
            "$ref": "#/components/schemas/BooleanFilterField",
            "description": "Task Is WBS filter field.",
            "nullable": true
        },
        "taskName": {
            "$ref": "#/components/schemas/StringFilterField",
            "description": "Task Name filter field.",
            "nullable": true
        },
        "taskPercentComplete": {
            "$ref": "#/components/schemas/Int32FilterField",
            "description": "Task Percent Complete filter field.",
            "nullable": true
        },
        "taskPhysicalQuantityUnit": {
            "$ref": "#/components/schemas/ResourceUnitTypeFilterField",
            "description": "Task Physical Quantity Unit filter field.",
            "nullable": true
        },
        "taskPlannedDuration": {
            "$ref": "#/components/schemas/Int32FilterField",
            "description": "Task Planned Duration filter field.",
            "nullable": true
        },
        "taskPlannedPhysicalQuantity": {
            "$ref": "#/components/schemas/DoubleFilterField",
            "description": "Task Planned Physical Quantity filter field.",
            "nullable": true
        },
        "taskProgressType": {
            "$ref": "#/components/schemas/TaskProgressTypeFilterField",
            "description": "Task Progress Type filter field.",
            "nullable": true
        },
        "taskRemainingDuration": {
            "$ref": "#/components/schemas/Int32FilterField",
            "description": "Task Remaining Duration filter field.",
            "nullable": true
        },
        "taskRemainingPhysicalQuantity": {
            "$ref": "#/components/schemas/DoubleFilterField",
            "description": "Task Remaining Physical Quantity filter field.",
            "nullable": true
        },
        "taskStatus": {
            "$ref": "#/components/schemas/TaskStatusTypeFilterField",
            "description": "Task Status filter field.",
            "nullable": true
        },
        "taskType": {
            "$ref": "#/components/schemas/TaskTypeFilterField",
            "description": "Task Type filter field.",
            "nullable": true
        },
        "taskUrl": {
            "$ref": "#/components/schemas/StringFilterField",
            "description": "Task URL filter field.",
            "nullable": true
        },
        "taskUserDefinedId": {
            "$ref": "#/components/schemas/StringFilterField",
            "description": "Task User Defined ID filter field.",
            "nullable": true
        },
        "version": {
            "type": "integer",
            "description": "The version of the Task Query Filter.",
            "format": "int32"
        }
    },
    "additionalProperties": false,
    "description": "Properties of the Task Query Filter to be created."
}

Task Query Filter Response

Container for Task Query Filter object.

taskQueryFilter

TaskQueryFilter

Task Query Filter properties.

json

{
    "title": "Task Query Filter Response",
    "type": "object",
    "properties": {
        "taskQueryFilter": {
            "$ref": "#/components/schemas/TaskQueryFilter",
            "description": "Task Query Filter properties."
        }
    },
    "additionalProperties": false,
    "description": "Container for Task Query Filter object."
}

Task Status Type

Task status type specifies the current status of the Task.

Planned

String

Started

String

Finished

String

Unknown

String

json

{
    "title": "Task Status Type",
    "enum": [
        "Planned",
        "Started",
        "Finished",
        "Unknown"
    ],
    "type": "string",
    "description": "Task status type specifies the current status of the Task."
}

Task Status Type Filter Field

Representation of a filter field for Task Status Type enum values.

operation

Value matching operation for filtering.

values

TaskStatusType[]

Task Status Type enum values to filter by.

json

{
    "title": "Task Status Type Filter Field",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/FilterEnumOperation",
            "description": "Value matching operation for filtering."
        },
        "values": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskStatusType"
            },
            "description": "Task Status Type enum values to filter by."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a filter field for Task Status Type enum values."
}

Task Type

Task Type provides a categorization (or classification) of project Tasks. See the Task Types section for details.

Work

String

StartKeyDate

String

FinishKeyDate

String

ShortHammock

String

LongHammock

String

Rfi

String

ChangeOrder

String

Testing

String

Delivery

String

Meeting

String

Rework

String

Design

String

Maintenance

String

Manufacture

String

Storage

String

Purchase

String

Receive

String

Delay

String

WeatherDelay

String

Unknown

String

json

{
    "title": "Task Type",
    "enum": [
        "Work",
        "StartKeyDate",
        "FinishKeyDate",
        "ShortHammock",
        "LongHammock",
        "Rfi",
        "ChangeOrder",
        "Testing",
        "Delivery",
        "Meeting",
        "Rework",
        "Design",
        "Maintenance",
        "Manufacture",
        "Storage",
        "Purchase",
        "Receive",
        "Delay",
        "WeatherDelay",
        "Unknown"
    ],
    "type": "string",
    "description": "Task Type provides a categorization (or classification) of project Tasks. See the [Task Types](#task-types) section for details."
}

Task Type Filter Field

Representation of a filter field for Task Type enum values.

operation