Read CostAccount
get
/costAccount
Reads CostAccount objects from the database.
Request
Query Parameters
-
Fields(required): string
Fields to loadExample:
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 conditionExample:
ObjectId desc
Header Parameters
-
Authorization:
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : List<CostAccount>
Type:
array
Title:
Show Source
List<CostAccount>
-
Array of:
object CostAccount
Title:
CostAccount
CostAccount Entity
Nested Schema : CostAccount
Type:
object
Title:
CostAccount
CostAccount Entity
Show Source
-
CreateDate: string
(date-time)
The date this account was created.
-
CreateUser: string
The name of the user that created this account.
-
Description: string
The description of the cost account.
-
Id(required): string
The short ID assigned to each cost account for identification. Each cost account is uniquely identified by concatenating its own ID together with its parents' IDs.
-
LastUpdateDate: string
(date-time)
The date this account was last updated.
-
LastUpdateUser: string
The name of the user that last updated this account.
-
Name(required): string
The name of the cost account.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
ParentObjectId: integer
(int32)
The unique ID of the parent cost account of this cost account in the hierarchy.
-
SequenceNumber: integer
(int32)
The sequence number for sorting.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.