Jump to

• Request
• Response

Read ResourceAssignmentCodeAssignment

get

/resourceAssignmentCodeAssignment

Reads ResourceAssignmentCodeAssignment objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter: 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: string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization:
  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<ResourceAssignmentCodeAssignment>

Type: array

Title: List<ResourceAssignmentCodeAssignment>

Show Source

• Array of: object ResourceAssignmentCodeAssignment
  Title: ResourceAssignmentCodeAssignment

  ResourceAssignmentCodeAssignment Entity

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

Nested Schema : ResourceAssignmentCodeAssignment

Type: object

Title: ResourceAssignmentCodeAssignment

ResourceAssignmentCodeAssignment Entity

Show Source

• CreateDate: string (date-time)
  The date this code assignment was created.
• CreateUser: string
  The name of the user that created this code assignment.
• LastUpdateDate: string (date-time)
  The date this code assignment was last updated.
• LastUpdateUser: string
  The name of the user that last updated this code assignment.
• ProjectObjectId: integer (int32)
  The unique identifier of the project that is associated with the ResourceAssignmentCodeAssignment object.
• ResourceAssignmentCodeDescription: string
  The description of the associated code.
• ResourceAssignmentCodeObjectId: integer (int32)
  The unique ID of the associated code.
• ResourceAssignmentCodeTypeName: string
  The name of the parent code type.
• ResourceAssignmentCodeTypeObjectId: integer (int32)
  The unique ID of the parent code type.
• ResourceAssignmentCodeValue: string
  The value of the associated code.
• ResourceAssignmentObjectId: integer (int32)
  The object ID of the associated resource or role assignment.

{
    "title":"ResourceAssignmentCodeAssignment",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this code assignment was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this code assignment."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this code assignment was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this code assignment."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique identifier of the project that is associated with the ResourceAssignmentCodeAssignment object.",
            "format":"int32"
        },
        "ResourceAssignmentCodeDescription":{
            "type":"string",
            "description":"The description of the associated code."
        },
        "ResourceAssignmentCodeObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated code.",
            "format":"int32"
        },
        "ResourceAssignmentCodeTypeName":{
            "type":"string",
            "description":"The name of the parent code type."
        },
        "ResourceAssignmentCodeTypeObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent code type.",
            "format":"int32"
        },
        "ResourceAssignmentCodeValue":{
            "type":"string",
            "description":"The value of the associated code."
        },
        "ResourceAssignmentObjectId":{
            "type":"integer",
            "description":"The object ID of the associated resource or role assignment.",
            "format":"int32"
        }
    },
    "description":"ResourceAssignmentCodeAssignment 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