Jump to

• Request
• Response

Read ActivitySteps

get

/activityStep

Reads ActivityStep 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<ActivityStep>

Type: array

Title: List<ActivityStep>

Show Source

• Array of: object ActivityStep
  Title: ActivityStep

  ActivityStep Entity

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

Nested Schema : ActivityStep

Type: object

Title: ActivityStep

ActivityStep Entity

Show Source

• ActivityId: string
  The short ID that uniquely identifies the activity within the project.
• ActivityName(required): string
  The name of the activity. The activity name does not have to be unique.
• ActivityObjectId(required): integer (int32)
  The unique ID of the activity to which the steps are assigned.
• CreateDate: string (date-time)
  The date this activity step was created.
• CreateUser: string
  The name of the user that created this activity step.
• Description: string
  The description of the activity step.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline
• IsCompleted: boolean
  The flag that indicates whether the step has been completed.
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this activity step was last updated.
• LastUpdateUser: string
  The name of the user that last updated this activity step.
• Name: string
  The name of the activity step.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• PercentComplete: number (double)
  The percent complete for the step.
• ProjectId: string
  The short code that uniquely identifies the project.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• SequenceNumber: integer (int32)
  The sequence number for sorting.
• WBSObjectId: integer (int32)
  The unique ID of the WBS for the activity.
• Weight: number (double)
  The weight that is assigned to the step. This is a user defined field that is used to calculate the physical percent complete when the project option is set.
• WeightPercent: number (double)
  The non-editable field that displays the percentage amount that corresponds to the step. It is calculated by taking the weight of the step and dividing it by the total of all weights for the activity.

{
    "title":"ActivityStep",
    "required":[
        "ActivityName",
        "ActivityObjectId"
    ],
    "type":"object",
    "properties":{
        "ActivityId":{
            "type":"string",
            "description":"The short ID that uniquely identifies the activity within the project."
        },
        "ActivityName":{
            "type":"string",
            "description":"The name of the activity. The activity name does not have to be unique."
        },
        "ActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the activity to which the steps are assigned.",
            "format":"int32"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this activity step was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this activity step."
        },
        "Description":{
            "type":"string",
            "description":"The description of the activity step."
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline"
        },
        "IsCompleted":{
            "type":"boolean",
            "description":"The flag that indicates whether the step has been completed."
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this activity step was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this activity step."
        },
        "Name":{
            "type":"string",
            "description":"The name of the activity step."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "PercentComplete":{
            "type":"number",
            "description":"The percent complete for the step.",
            "format":"double"
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the WBS for the activity.",
            "format":"int32"
        },
        "Weight":{
            "type":"number",
            "description":"The weight that is assigned to the step. This is a user defined field that is used to calculate the physical percent complete when the project option is set.",
            "format":"double"
        },
        "WeightPercent":{
            "type":"number",
            "description":"The non-editable field that displays the percentage amount that corresponds to the step. It is calculated by taking the weight of the step and dividing it by the total of all weights for the activity.",
            "format":"double"
        }
    },
    "description":"ActivityStep 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