Project Capacity User

Project Capacity User - Get Project Capacity User

HTTP Request

GET /api/project-capacity-user/{id}

Interactive Demo

📋 Description: Retrieves detailed capacity information for a specific user within the Nakisa Portfolio Management Suite, enabling effective portfolio and asset management analytics in the context of real estate properties.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ProjectCapacityUserDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "allocatedHours": 0,
  "planningId": 0,
  "userId": 0
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Project Capacity User - Update Project Capacity User

HTTP Request

PUT /api/project-capacity-user/{id}

Interactive Demo

📋 Description: Updates the capacity allocation for a specific user within a project, enabling enhanced resource management and analytics in the Nakisa Portfolio Management Suite.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ProjectCapacityUserDto	true	Request body containing updated user capacity data, including role assignments and availability metrics, relevant for portfolio and asset management analytics.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "allocatedHours": 0,
  "planningId": 0,
  "userId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Project Capacity User - Delete Project Capacity User

HTTP Request

DELETE /api/project-capacity-user/{id}

Interactive Demo

📋 Description: Deletes a specified user’s capacity allocation within the Nakisa Portfolio Management Suite, ensuring accurate portfolio and asset analytics for real estate property management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Project Capacity User - Create Capacity User Dto

HTTP Request

POST /api/project-capacity-user

Interactive Demo

📋 Description: Creates a new user capacity entry for project management within the Nakisa Portfolio Management Suite, enabling enhanced analytics and resource allocation for real estate property portfolios.

Parameters

Name	In	Type	Required	Description
body	body	ProjectCapacityUserDto	true	Request body containing user capacity data for project allocation, including user identifiers, role specifications, and associated portfolio metrics.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "allocatedHours": 0,
  "planningId": 0,
  "userId": 0
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	integer

Example Responses

0

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Project Capacity User - Get Project Capacity User By Project ID

HTTP Request

GET /api/project-capacity-user/project/{projectId}

Interactive Demo

📋 Description: Retrieves user capacity details for a specific project identified by the projectId, enabling effective resource allocation and analytics within the Nakisa Portfolio Management Suite.

Parameters

Name	In	Type	Required	Description
projectId	path	integer(int64)	true	Unique identifier for the project

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "allocatedHours": 0,
    "planningId": 0,
    "userId": 0
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ProjectCapacityUserDto]	false	none	[Data transfer object representing the capacity allocation of users within the Nakisa Portfolio Management Suite, facilitating effective resource management and analytics for portfolio and asset optimization in real estate properties.]
» createdBy	string	false	none	Username of who created this resource
» lastModifiedBy	string	false	none	Username of who last modified this resource
» createdDate	string(date-time)	false	none	Date of the created
» lastModifiedDate	string(date-time)	false	none	Date of the last modified
» archived	boolean	false	none	Boolean flag indicating archived status
» externalId	string	false	none	Unique identifier for the external
» id	integer(int64)	false	none	Unique identifier for the resource
» allocatedHours	integer(int32)	false	none	Numeric value representing allocatedHours
» planningId	integer(int64)	true	none	Unique identifier for the planning
» userId	integer(int64)	false	none	Unique identifier for the user

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Project Capacity User - Get Project Capacity Users By Project ID

HTTP Request

GET /api/project-capacity-user/project/{projectId}/users

Interactive Demo

Parameters

Name	In	Type	Required	Description
projectId	path	integer(int64)	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "email": "string",
    "userName": "string",
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "permissions": "string",
    "internalId": "string",
    "preferredCulture": {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "name": "string",
      "code": "string",
      "defaultCulture": true,
      "enable": true
    },
    "userGroups": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "name": "string",
        "description": "string",
        "internalId": "string"
      }
    ],
    "partnerIds": [
      0
    ],
    "partners": [
      {
        "id": 0,
        "status": "CREATED",
        "displayId": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "name": "string",
        "fax": "string",
        "phone": "string",
        "parentId": 0,
        "parentName": "string",
        "parentDisplayId": "string",
        "companyId": 0,
        "partnerRoleId": 0,
        "partnerContactId": 0
      }
    ]
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[UserDto]	false	none	[Data transfer object representing a user within the Nakisa Portfolio Management Suite, encapsulating essential information for managing portfolio, asset, and analytics interactions related to real estate properties.]
» createdBy	string	false	none	Username of who created this resource
» lastModifiedBy	string	false	none	Username of who last modified this resource
» createdDate	string(date-time)	false	none	Date of the created
» lastModifiedDate	string(date-time)	false	none	Date of the last modified
» archived	boolean	false	none	Boolean flag indicating archived status
» externalId	string	false	none	Unique identifier for the external
» id	integer(int64)	false	none	Unique identifier for the resource
» email	string	true	none	Email address of the user, utilized for communication and notifications related to portfolio, asset, and analytics management within the Nakisa Portfolio Management Suite.
» userName	string	true	none	Name of the user
» firstName	string	true	none	Name of the first
» lastName	string	true	none	Name of the last
» displayName	string	false	none	Display name for user interface
» permissions	string	false	none	Specifies the access rights assigned to a user within the Nakisa Portfolio Management Suite, governing their interactions with portfolio, asset, analytics, and real estate property data.
» internalId	string	false	none	Unique identifier for the internal
» preferredCulture	Culture	false	none	Data transfer object representing cultural attributes and insights related to portfolio assets within the Nakisa Portfolio Management Suite, facilitating informed decision-making in real estate property analytics.
»» createdBy	string	false	none	Username of who created this resource
»» lastModifiedBy	string	false	none	Username of who last modified this resource
»» createdDate	string(date-time)	false	none	Date of the created
»» lastModifiedDate	string(date-time)	false	none	Date of the last modified
»» archived	boolean	false	none	Boolean flag indicating archived status
»» externalId	string	false	none	Unique identifier for the external
»» id	integer(int64)	false	none	Unique identifier for the resource
»» name	string	false	none	Name of the resource
»» code	string	false	none	Code identifier for the resource
»» defaultCulture	boolean	false	none	Boolean flag indicating defaultCulture status
»» enable	boolean	false	none	Boolean flag indicating enable status
» userGroups	[UserGroup]	false	none	User information related to portfolio management
»» createdBy	string	false	none	Username of who created this resource
»» lastModifiedBy	string	false	none	Username of who last modified this resource
»» createdDate	string(date-time)	false	none	Date of the created
»» lastModifiedDate	string(date-time)	false	none	Date of the last modified
»» archived	boolean	false	none	Boolean flag indicating archived status
»» externalId	string	false	none	Unique identifier for the external
»» id	integer(int64)	false	none	Unique identifier for the resource
»» name	string	true	none	Name of the resource
»» description	string	false	none	Description of the resource
»» internalId	string	false	none	Unique identifier for the internal
» partnerIds	[integer]	false	none	List of partnerIds items
» partners	[PartnerDto]	false	none	List of partners items
»» id	integer(int64)	false	none	Unique identifier for the resource
»» status	string	false	none	Status of the resource
»» displayId	string	true	none	Unique identifier for the display
»» erpSystemId	integer(int64)	false	none	Unique identifier for the erp system
»» erpSystemDisplayId	string	false	none	Unique identifier for the erp system display
»» name	string	false	none	Name of the resource
»» fax	string	false	none	Fax number associated with the partner, used for communication regarding portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.
»» phone	string	false	none	Contact number for the partner associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite.
»» parentId	integer(int64)	false	none	Unique identifier for the parent
»» parentName	string	false	none	Name of the parent
»» parentDisplayId	string	false	none	Unique identifier for the parent display
»» companyId	integer(int64)	false	none	Unique identifier for the company
»» partnerRoleId	integer(int64)	false	none	Unique identifier for the partner role
»» partnerContactId	integer(int64)	false	none	Unique identifier for the partner contact

Enumerated Values

Attribute	Value
status	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---