Jump to

• Request
• Response

Read ActivityStepTemplateItems

get

/activityStepTemplateItem

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

Type: array

Title: List<ActivityStepTemplateItem>

Show Source

• Array of: object ActivityStepTemplateItem
  Title: ActivityStepTemplateItem

  ActivityStepTemplateItem Entity

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

Nested Schema : ActivityStepTemplateItem

Type: object

Title: ActivityStepTemplateItem

ActivityStepTemplateItem Entity

Show Source

• ActivityStepTemplateObjectId: integer (int32)
  The unique ID of the activity step template to which this item belongs.
• CreateDate: string (date-time)
  The date this activity step template item was created.
• CreateUser: string
  The name of the user that created this activity step template item.
• Description: string
  The description of the activity step.
• LastUpdateDate: string (date-time)
  The date this activity step template item was last updated.
• LastUpdateUser: string
  The name of the user that last updated this activity step template item.
• Name: string
  The name of the activity step template item.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• SequenceNumber: integer (int32)
  The sequence number for sorting.
• 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.

{
    "title":"ActivityStepTemplateItem",
    "type":"object",
    "properties":{
        "ActivityStepTemplateObjectId":{
            "type":"integer",
            "description":"The unique ID of the activity step template to which this item belongs.",
            "format":"int32"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this activity step template item was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this activity step template item."
        },
        "Description":{
            "type":"string",
            "description":"The description of the activity step."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this activity step template item was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this activity step template item."
        },
        "Name":{
            "type":"string",
            "description":"The name of the activity step template item."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "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"
        }
    },
    "description":"ActivityStepTemplateItem 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