Jump to

• Request
• Response

Read ResourceAssignmentUpdate

get

/resourceAssignmentUpdate

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

Type: array

Title: List<ResourceAssignmentUpdate>

Show Source

• Array of: object ResourceAssignmentUpdate
  Title: ResourceAssignmentUpdate

  ResourceAssignmentUpdate Entity

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

Nested Schema : ResourceAssignmentUpdate

Type: object

Title: ResourceAssignmentUpdate

ResourceAssignmentUpdate Entity

Show Source

• ActivityObjectId: integer (int32)
  The name of the Contract Management Group.
• AllData: string
  The unique ID of the activity to which the activity code is assigned.
• ApprovalDate: string (date-time)
  The date that the activity was approved.
• ApprovalUserName: string
  The username of the approved user.
• ApprovalUserObjectId: integer (int32)
  The unique ID generated by the system for the approved user.
• CalendarId: integer (int32)
• ChangeSetObjectId(required): integer (int32)
  The unique ID generated by the system for the change set object.
• CreateUser: string
• Date: string (date-time)
  The date of the resource assignment update.
• HeldDate: string (date-time)
  The date of the held resource assignment.
• OverrideActualFinishDate: string (date-time)
  The actual finish date for an override activity.
• OverrideActualStartDate: string (date-time)
  The actual start date for an override activity.
• OverrideActualUnits: number (double)
  The number of units for an override activity.
• OverrideRemainingDuration: number (double)
  The remaining duration for an override activity.
• OverrideRemainingFinishDate: string (date-time)
  The date that the override activity finishes.
• OverrideRemainingUnits: number (double)
  The overridden new remaining units of work to be performed by this resource on this activity.
• PendingActualFinishDate: string (date-time)
  The date on which the pending activity actually finishes if approval is required.
• PendingActualStartDate: string (date-time)
  The date on which the pending activity actually starts if approval is required.
• PendingActualUnits: number (double)
  The actual number of units associated with the the pending activity if approval is required.
• PendingRemainingDuration: number (double)
  The remaining duration that is required to finish a pending activity if approval is required.
• PendingRemainingFinishDate: string (date-time)
  The remaining finish date of a pending activity if approval is required.
• PendingRemainingUnits: number (double)
  The remaining number of units associated with a pending activity if approval is required.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• RejectedBy: string
• RejectedDate: string (date-time)
• RequestUserObjectId: integer (int32)
  The unique ID of the user modifying the task, assignment, or step.
• ResourceAssignmentObjectId(required): integer (int32)
  The unique identifier for the ResourceAssignment. You can specify one or more ResourceAssignmentObjectID.
• ResubmittedBy: string
• ResubmittedDate: string (date-time)
• Status: string
  The status of this budget change request. Possible values are 'Pending', 'Held', and 'Approved'.

{
    "title":"ResourceAssignmentUpdate",
    "required":[
        "ChangeSetObjectId",
        "ResourceAssignmentObjectId"
    ],
    "type":"object",
    "properties":{
        "ActivityObjectId":{
            "type":"integer",
            "description":"The name of the Contract Management Group.",
            "format":"int32"
        },
        "AllData":{
            "type":"string",
            "description":"The unique ID of the activity to which the activity code is assigned."
        },
        "ApprovalDate":{
            "type":"string",
            "description":"The date that the activity was approved.",
            "format":"date-time"
        },
        "ApprovalUserName":{
            "type":"string",
            "description":"The username of the approved user."
        },
        "ApprovalUserObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system for the approved user.",
            "format":"int32"
        },
        "CalendarId":{
            "type":"integer",
            "format":"int32"
        },
        "ChangeSetObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system for the change set object.",
            "format":"int32"
        },
        "CreateUser":{
            "type":"string"
        },
        "Date":{
            "type":"string",
            "description":"The date of the resource assignment update.",
            "format":"date-time"
        },
        "HeldDate":{
            "type":"string",
            "description":"The date of the held resource assignment.",
            "format":"date-time"
        },
        "OverrideActualFinishDate":{
            "type":"string",
            "description":"The actual finish date for an override activity.",
            "format":"date-time"
        },
        "OverrideActualStartDate":{
            "type":"string",
            "description":"The actual start date for an override activity.",
            "format":"date-time"
        },
        "OverrideActualUnits":{
            "type":"number",
            "description":"The number of units for an override activity.",
            "format":"double"
        },
        "OverrideRemainingDuration":{
            "type":"number",
            "description":"The remaining duration for an override activity.",
            "format":"double"
        },
        "OverrideRemainingFinishDate":{
            "type":"string",
            "description":"The date that the override activity finishes.",
            "format":"date-time"
        },
        "OverrideRemainingUnits":{
            "type":"number",
            "description":"The overridden new remaining units of work to be performed by this resource on this activity.",
            "format":"double"
        },
        "PendingActualFinishDate":{
            "type":"string",
            "description":"The date on which the pending activity actually finishes if approval is required.",
            "format":"date-time"
        },
        "PendingActualStartDate":{
            "type":"string",
            "description":"The date on which the pending activity actually starts if approval is required.",
            "format":"date-time"
        },
        "PendingActualUnits":{
            "type":"number",
            "description":"The actual number of units associated with the the pending activity if approval is required.",
            "format":"double"
        },
        "PendingRemainingDuration":{
            "type":"number",
            "description":"The remaining duration that is required to finish a pending activity if approval is required.",
            "format":"double"
        },
        "PendingRemainingFinishDate":{
            "type":"string",
            "description":"The remaining finish date of a pending activity if approval is required.",
            "format":"date-time"
        },
        "PendingRemainingUnits":{
            "type":"number",
            "description":"The remaining number of units associated with a pending activity if approval is required.",
            "format":"double"
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "RejectedBy":{
            "type":"string"
        },
        "RejectedDate":{
            "type":"string",
            "format":"date-time"
        },
        "RequestUserObjectId":{
            "type":"integer",
            "description":"The unique ID of the user modifying the task, assignment, or step.",
            "format":"int32"
        },
        "ResourceAssignmentObjectId":{
            "type":"integer",
            "description":"The unique identifier for the ResourceAssignment. You can specify one or more ResourceAssignmentObjectID.",
            "format":"int32"
        },
        "ResubmittedBy":{
            "type":"string"
        },
        "ResubmittedDate":{
            "type":"string",
            "format":"date-time"
        },
        "Status":{
            "type":"string",
            "description":"The status of this budget change request. Possible values are 'Pending', 'Held', and 'Approved'."
        }
    },
    "description":"ResourceAssignmentUpdate 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