Project¶
Project - Get¶
HTTP Request
GET /api/v1/projects/{id}
📋 Description: Retrieves detailed information about a specific financial entity’s project within the organizational structure, identified by the provided project ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "workBreakdownStructureId": 0,
22 "companyId": 0
23 }
24}
Project - Update¶
HTTP Request
PUT /api/v1/projects/{id}
📋 Description: Updates the details of a specified financial entity within the organization’s structure, allowing for modifications to the project’s hierarchy and attributes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated details of the financial entity’s project, including organizational structure, hierarchy adjustments, and relevant metadata. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "workBreakdownStructureId": 0,
9 "companyId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "workBreakdownStructureId": 0,
22 "companyId": 0
23 }
24}
Project - Delete¶
HTTP Request
DELETE /api/v1/projects/{id}
📋 Description: Deletes a specified project from the financial organization structure, thereby removing it from the hierarchy of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Project - Delete Or Decommission¶
HTTP Request
PUT /api/v1/projects/remove/{id}
📋 Description: Removes a specified project from the financial organization structure, ensuring that the hierarchy remains accurate and up-to-date for effective management of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Project - Delete Or Decommission All¶
HTTP Request
PUT /api/v1/projects/remove/bulk
📋 Description: Removes multiple projects from the financial organization structure in a single operation, streamlining the management of the hierarchy within the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of project identifiers to be removed in bulk from the financial organization structure, ensuring streamlined management of organizational hierarchy. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Project - Decommission¶
HTTP Request
PUT /api/v1/projects/decommission/{id}
📋 Description: Decommissions a specified project within the financial organization structure, effectively removing it from the active hierarchy and ensuring accurate representation of the entity’s organizational framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "workBreakdownStructureId": 0,
22 "companyId": 0
23 }
24}
Project - Decommission By Modification Date Before¶
HTTP Request
PUT /api/v1/projects/decommission/modified-before/{modified_before}
📋 Description: Updates the status of financial entities within the organization structure that were modified before the specified date, facilitating effective management of the hierarchy and ensuring compliance with organizational policies.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
modified_before |
path |
string(date-time) |
true |
Specifies the cutoff date for retrieving projects that were modified before the given date, facilitating effective management of organizational structure changes within financial entities. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "workBreakdownStructureId": 0,
23 "companyId": 0
24 }
25 ]
26}
Project - Decommission Before Now¶
HTTP Request
PUT /api/v1/projects/decommission/modified-before-now
📋 Description: Updates the status of financial organization projects that were modified before the current date, facilitating the management of the organizational structure and hierarchy within the financial entity.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "workBreakdownStructureId": 0,
23 "companyId": 0
24 }
25 ]
26}
Project - Decommission All¶
HTTP Request
PUT /api/v1/projects/decommission/bulk
📋 Description: Updates the status of multiple projects to ‘decommission’ within the financial organization structure, facilitating the management of organizational hierarchy and resource allocation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of financial entity identifiers and their corresponding decommissioning details to facilitate bulk updates within the organization’s hierarchical structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "workBreakdownStructureId": 0,
23 "companyId": 0
24 }
25 ]
26}
Project - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/projects/createOrUpdate/bulk
📋 Description: Updates or creates multiple financial organization structures in bulk, enabling efficient management of hierarchies and entities within the financial domain.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating financial organization structures, including details on hierarchy and associated financial entities. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "workBreakdownStructureId": 0,
10 "companyId": 0
11 }
12]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "workBreakdownStructureId": 0,
23 "companyId": 0
24 }
25 ]
26}
Project - Create Or Update¶
HTTP Request
PUT /api/v1/projects/createOrUpdate
📋 Description: Creates or updates a financial organization structure within the specified hierarchy, ensuring that the project aligns with the overall organizational framework of the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial organization structure data, including details on hierarchy and entity attributes for creating or updating projects. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "workBreakdownStructureId": 0,
9 "companyId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "workBreakdownStructureId": 0,
22 "companyId": 0
23 }
24}
Project - Bulk Update¶
HTTP Request
PUT /api/v1/projects/bulk
📋 Description: Updates the financial organization structure by allowing bulk modifications to project hierarchies within a specified financial entity, ensuring alignment with organizational goals.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of financial entity project updates, including organizational structure and hierarchy details for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "workBreakdownStructureId": 0,
10 "companyId": 0
11 }
12]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "workBreakdownStructureId": 0,
23 "companyId": 0
24 }
25 ]
26}
Project - Bulk Create¶
HTTP Request
POST /api/v1/projects/bulk
📋 Description: Submits a bulk creation request for multiple financial organization structures, allowing for efficient management of hierarchical relationships within financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of financial entity project data, including organization structure and hierarchy details for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "workBreakdownStructureId": 0,
10 "companyId": 0
11 }
12]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "workBreakdownStructureId": 0,
23 "companyId": 0
24 }
25 ]
26}
Project - Bulk Delete¶
HTTP Request
DELETE /api/v1/projects/bulk
📋 Description: Deletes multiple projects within the financial organization structure, allowing for efficient management of the hierarchy and organization of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of project identifiers to facilitate the bulk deletion of financial entities within the organizational structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Project - Search¶
HTTP Request
POST /api/v1/projects/search
📋 Description: Submits a search request to retrieve financial organization structures, enabling users to explore and analyze the hierarchy of financial entities within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing search criteria and filters to retrieve financial organization structure data, including hierarchy and entity details. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "statusEqual": "CREATED",
16 "statusIn": [
17 "CREATED"
18 ],
19 "displayIdIn": [
20 "string"
21 ],
22 "displayIdLike": "string",
23 "erpSystemIdEqual": 0,
24 "erpSystemIdIn": [
25 0
26 ],
27 "erpSystemDisplayIdLike": "string",
28 "nameLike": "string",
29 "workBreakdownStructureIdEqual": 0,
30 "companyIdEqual": 0
31}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "workBreakdownStructureId": 0,
27 "companyId": 0
28 }
29 ],
30 "number": 0,
31 "sort": {
32 "unsorted": true,
33 "sorted": true,
34 "empty": true
35 },
36 "first": true,
37 "last": true,
38 "empty": true
39}
Project - Detach Company¶
HTTP Request
POST /api/v1/projects/detach/company/{company_id}
📋 Description: Detaches a specified company from its associated project within the financial organization structure, facilitating adjustments to the organizational hierarchy and enhancing financial entity management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
company_id |
path |
integer(int64) |
true |
Unique identifier for the financial entity within the organizational structure, used to detach a company from a project. |
body |
body |
true |
Request body containing the financial entity details necessary to detach a company from the organizational structure, including relevant identifiers and hierarchy information. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "workBreakdownStructureId": 0,
10 "companyId": 0
11 }
12]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Project - Attach Company¶
HTTP Request
POST /api/v1/projects/attach/company/{company_id}
📋 Description: Attaches a specified company to a project within the financial organization structure, facilitating the integration of financial entities into the established hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
company_id |
path |
integer(int64) |
true |
Unique identifier for the financial entity within the organizational structure, used to associate a project with a specific company during the attachment process. |
body |
body |
true |
Request body containing the financial entity details required to associate a company with the organizational structure and hierarchy of projects. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "workBreakdownStructureId": 0,
10 "companyId": 0
11 }
12]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Project - Find All¶
HTTP Request
GET /api/v1/projects
📋 Description: Retrieves a list of financial entities within the organization’s structure, providing insights into the hierarchy and relationships among projects.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the financial organization structure query should be returned in a paginated format, facilitating efficient navigation through large datasets. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "workBreakdownStructureId": 0,
27 "companyId": 0
28 }
29 ],
30 "number": 0,
31 "sort": {
32 "unsorted": true,
33 "sorted": true,
34 "empty": true
35 },
36 "first": true,
37 "last": true,
38 "empty": true
39}
Project - Create¶
HTTP Request
POST /api/v1/projects
📋 Description: Creates a new project within the financial organization structure, enabling the establishment of hierarchical relationships and management of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entity’s project details, including name, description, budget, and hierarchical structure within the organization. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "workBreakdownStructureId": 0,
9 "companyId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "workBreakdownStructureId": 0,
22 "companyId": 0
23 }
24}
Project - Get Metadata¶
HTTP Request
GET /api/v1/projects/meta
📋 Description: Retrieves metadata related to the financial organization structure, including details on hierarchy and relationships among financial entities.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "NAME"
3]
Response Schema
Project - Find All By System ID¶
HTTP Request
GET /api/v1/projects/erp-system/{systemId}
📋 Description: Retrieves detailed information about a specific financial entity’s organizational structure within the ERP system, identified by the provided system ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
systemId |
path |
integer(int64) |
true |
Unique identifier for the system |
pageable |
query |
true |
Indicates whether the results of the financial organization structure query should be returned in a paginated format, facilitating efficient navigation through potentially large datasets related to the specified ERP system. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "workBreakdownStructureId": 0,
27 "companyId": 0
28 }
29 ],
30 "number": 0,
31 "sort": {
32 "unsorted": true,
33 "sorted": true,
34 "empty": true
35 },
36 "first": true,
37 "last": true,
38 "empty": true
39}
Project - Get All By Company¶
HTTP Request
GET /api/v1/projects/company/{company_id}
📋 Description: Retrieves the organizational structure of financial projects associated with a specified company, providing insights into the hierarchy and relationships within the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
company_id |
path |
integer(int64) |
true |
Unique identifier for the financial entity within the organizational structure, used to retrieve associated projects. |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure of the specified company. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "workBreakdownStructureId": 0,
27 "companyId": 0
28 }
29 ],
30 "number": 0,
31 "sort": {
32 "unsorted": true,
33 "sorted": true,
34 "empty": true
35 },
36 "first": true,
37 "last": true,
38 "empty": true
39}