Jump to

• Request
• Response

Read ResourceAssignmentPeriodActual

get

/resourceAssignmentPeriodActual

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

Type: array

Title: List<ResourceAssignmentPeriodActual>

Show Source

• Array of: object ResourceAssignmentPeriodActual
  Title: ResourceAssignmentPeriodActual

  ResourceAssignmentPeriodActual Entity

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

Nested Schema : ResourceAssignmentPeriodActual

Type: object

Title: ResourceAssignmentPeriodActual

ResourceAssignmentPeriodActual Entity

Show Source

• ActivityObjectId: integer (int32)
  The unique ID of the associated activity.
• ActualCost(required): number (double)
  The actual cost on this resource assignment during a financial period.
• ActualUnits(required): number (double)
  The actual units on this resource assignment during a financial period.
• CreateDate: string (date-time)
  The date this resource assignment period actual was created.
• CreateUser: string
  The name of the user that created this resource assignment period actual.
• FinancialPeriodObjectId(required): integer (int32)
  The unique ID of the associated financial period.
• 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 resource assignment period actual was last updated.
• LastUpdateUser: string
  The name of the user that last updated this resource assignment period actual.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• ResourceAssignmentObjectId(required): integer (int32)
  The unique ID of the associated resource assignment.
• ResourceType: string
  The resource type: "Labor", "Nonlabor", or "Material".
• WBSObjectId: integer (int32)
  The unique ID of the WBS for the associated activity.

{
    "title":"ResourceAssignmentPeriodActual",
    "required":[
        "ActualCost",
        "ActualUnits",
        "FinancialPeriodObjectId",
        "ResourceAssignmentObjectId"
    ],
    "type":"object",
    "properties":{
        "ActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated activity.",
            "format":"int32"
        },
        "ActualCost":{
            "type":"number",
            "description":"The actual cost on this resource assignment during a financial period.",
            "format":"double"
        },
        "ActualUnits":{
            "type":"number",
            "description":"The actual units on this resource assignment during a financial period.",
            "format":"double"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this resource assignment period actual was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this resource assignment period actual."
        },
        "FinancialPeriodObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated financial period.",
            "format":"int32"
        },
        "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 resource assignment period actual was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this resource assignment period actual."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "ResourceAssignmentObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource assignment.",
            "format":"int32"
        },
        "ResourceType":{
            "type":"string",
            "description":"The resource type: \"Labor\", \"Nonlabor\", or \"Material\"."
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the WBS for the associated activity.",
            "format":"int32"
        }
    },
    "description":"ResourceAssignmentPeriodActual 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