Jump to

• Request
• Response

Read ActivityOwners

get

/activityOwner

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

Type: array

Title: List<ActivityOwner>

Show Source

• Array of: object ActivityOwner
  Title: ActivityOwner

  ActivityOwner Entity

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

Nested Schema : ActivityOwner

Type: object

Title: ActivityOwner

ActivityOwner Entity

Show Source

• ActivityObjectId(required): integer (int32)
  The unique ID of the associated activity.
• CreateDate: string (date-time)
  The date this activity owner was created.
• CreateUser: string
  The name of the user that created this activity owner.
• IsActivityFlagged: boolean
  The flag that indicates whether the owner of the activity has flagged the activity as important.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline.
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this activity owner was last updated.
• LastUpdateUser: string
  The name of the user that last updated this activity owner.
• ProjectFlag: string
  Indicates if this WBS node is a Project/EPS node.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• ProjectProjectFlag: string
  Indicates if this Project/EPS node is a Project or EPS.
• StatusCode: string
  The project status, either 'Planned', 'Active', 'Inactive', 'What-If', 'Requested', or 'Template'.
• UserObjectId(required): integer (int32)
  The unique ID of the associated user.

{
    "title":"ActivityOwner",
    "required":[
        "ActivityObjectId",
        "UserObjectId"
    ],
    "type":"object",
    "properties":{
        "ActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated activity.",
            "format":"int32"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this activity owner was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this activity owner."
        },
        "IsActivityFlagged":{
            "type":"boolean",
            "description":"The flag that indicates whether the owner of the activity has flagged the activity as important."
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline."
        },
        "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 owner was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this activity owner."
        },
        "ProjectFlag":{
            "type":"string",
            "description":"Indicates if this WBS node is a Project/EPS node."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "ProjectProjectFlag":{
            "type":"string",
            "description":"Indicates if this Project/EPS node is a Project or EPS."
        },
        "StatusCode":{
            "type":"string",
            "description":"The project status, either 'Planned', 'Active', 'Inactive', 'What-If', 'Requested', or 'Template'."
        },
        "UserObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated user.",
            "format":"int32"
        }
    },
    "description":"ActivityOwner 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