View all projects by parent code.

get

/primeapi/restapi/project/byParent?workspaceCode={workspaceCode}

Send a request to this endpoint to view all projects under parent with codes matching the code fields in query parameters.

Request

Query Parameters

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ApiEntityProject
Type: object
Show Source
Nested Schema : Duration
Type: object
Show Source
Nested Schema : codeValuesProject
Type: array
Unique Items Required: true
The categories of a project.
Show Source
Nested Schema : Percent
Type: object
Show Source
Nested Schema : ApiEntityProjectImage
Type: object
Show Source
Nested Schema : projectAutoNumber
Type: array
Read Only: true
Unique Items Required: true
The autonumber settings of a project.
Show Source
Nested Schema : projectCashFlows
Type: array
The cash flow of a project.
Show Source
Nested Schema : ApiEntityProjectConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityProjectFinancial
Type: object
Show Source
Nested Schema : projectSettings
Type: array
Read Only: true
Unique Items Required: true
Show Source
Nested Schema : ApiEntityCodeValueProject
Type: object
Show Source
Nested Schema : ApiEntityCodeType
Type: object
Show Source
Nested Schema : ApiEntityCodeValue
Type: object
Show Source
Nested Schema : assignments
Type: array
Unique Items Required: true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type: object
Show Source
  • ApiEntityCodeType
  • Allowed Values: [ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
    Indicates the type of object the code is associated to.
  • The unique identifier of a code type table.
  • Read Only: true
    Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : image
Type: array
The image file uploaded to the project.
Displayed throughout the application in areas like news feeds.
Show Source
Nested Schema : ApiEntityProjectAutoNumber
Type: object
Show Source
  • Allowed Values: [ "IDEA", "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "ACTUALS", "WORK_MANAGER_TASK", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM" ]
    Identifies the type of object used for auto numbering.
  • The number to increment the starting number by.
  • This is an internal field.
  • Allowed Values: [ "Length[1-20]" ]
    The initial characters for the auto numbering sequence.
  • The auto generated ID for the object. This value should not be provided in create operation request data, however, it is required for update requests.
  • The first number in the auto numbering sequence.
  • Read Only: true
    Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityProjectCashFlow
Type: object
Show Source
Nested Schema : Cost
Type: object
Nested Schema : costFlexMap
Type: object
Additional Properties Allowed
Show Source
The cost fields associated with a project.
Nested Schema : otherFlexMap
Type: object
Additional Properties Allowed
Show Source
The non-cost and non-text fields associated with a project.
Nested Schema : textFlexMap
Type: object
Additional Properties Allowed
Show Source
The text fields associated with a project.
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Nested Schema : ApiEntityProjectSetting
Type: object
Show Source

204 Response

Successful operation with no content.

404 Response

The requested project does not exist, or you do not have access to it.