Project Signature

Project Signature - Get Project Signature

HTTP Request

GET /api/project-signatures/{id}

📋 Description: Retrieves the details of a specific project signature by its unique identifier, facilitating insights into portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ProjectSignatureDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "level": 0,
10  "approveDate": "2019-08-24",
11  "isApproved": true,
12  "projectId": 0,
13  "userId": 0,
14  "userDto": {
15    "createdBy": "string",
16    "lastModifiedBy": "string",
17    "createdDate": "2019-08-24T14:15:22Z",
18    "lastModifiedDate": "2019-08-24T14:15:22Z",
19    "archived": true,
20    "externalId": "string",
21    "id": 0,
22    "email": "string",
23    "userName": "string",
24    "firstName": "string",
25    "lastName": "string",
26    "displayName": "string",
27    "permissions": "string",
28    "internalId": "string",
29    "preferredCulture": {
30      "createdBy": "string",
31      "lastModifiedBy": "string",
32      "createdDate": "2019-08-24T14:15:22Z",
33      "lastModifiedDate": "2019-08-24T14:15:22Z",
34      "archived": true,
35      "externalId": "string",
36      "id": 0,
37      "name": "string",
38      "code": "string",
39      "defaultCulture": true,
40      "enable": true
41    },
42    "userGroups": [
43      {
44        "createdBy": "string",
45        "lastModifiedBy": "string",
46        "createdDate": "2019-08-24T14:15:22Z",
47        "lastModifiedDate": "2019-08-24T14:15:22Z",
48        "archived": true,
49        "externalId": "string",
50        "id": 0,
51        "name": "string",
52        "description": "string",
53        "internalId": "string"
54      }
55    ],
56    "partnerIds": [
57      0
58    ],
59    "partners": [
60      {
61        "id": 0,
62        "status": "CREATED",
63        "displayId": "string",
64        "erpSystemId": 0,
65        "erpSystemDisplayId": "string",
66        "name": "string",
67        "fax": "string",
68        "phone": "string",
69        "parentId": 0,
70        "parentName": "string",
71        "parentDisplayId": "string",
72        "companyId": 0,
73        "partnerRoleId": 0,
74        "partnerContactId": 0
75      }
76    ]
77  }
78}

Project Signature - Update Project Signature

HTTP Request

PUT /api/project-signatures/{id}

📋 Description: Updates the project signature associated with the specified ID, enabling users to modify key attributes related to portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ProjectSignatureDto

true

Request body containing the updated project signature details, including relevant metadata and status, essential for portfolio and asset management within the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "level": 0,
10  "approveDate": "2019-08-24",
11  "isApproved": true,
12  "projectId": 0,
13  "userId": 0,
14  "userDto": {
15    "createdBy": "string",
16    "lastModifiedBy": "string",
17    "createdDate": "2019-08-24T14:15:22Z",
18    "lastModifiedDate": "2019-08-24T14:15:22Z",
19    "archived": true,
20    "externalId": "string",
21    "id": 0,
22    "email": "string",
23    "userName": "string",
24    "firstName": "string",
25    "lastName": "string",
26    "displayName": "string",
27    "permissions": "string",
28    "internalId": "string",
29    "preferredCulture": {
30      "createdBy": "string",
31      "lastModifiedBy": "string",
32      "createdDate": "2019-08-24T14:15:22Z",
33      "lastModifiedDate": "2019-08-24T14:15:22Z",
34      "archived": true,
35      "externalId": "string",
36      "id": 0,
37      "name": "string",
38      "code": "string",
39      "defaultCulture": true,
40      "enable": true
41    },
42    "userGroups": [
43      {
44        "createdBy": "string",
45        "lastModifiedBy": "string",
46        "createdDate": "2019-08-24T14:15:22Z",
47        "lastModifiedDate": "2019-08-24T14:15:22Z",
48        "archived": true,
49        "externalId": "string",
50        "id": 0,
51        "name": "string",
52        "description": "string",
53        "internalId": "string"
54      }
55    ],
56    "partnerIds": [
57      0
58    ],
59    "partners": [
60      {
61        "id": 0,
62        "status": "CREATED",
63        "displayId": "string",
64        "erpSystemId": 0,
65        "erpSystemDisplayId": "string",
66        "name": "string",
67        "fax": "string",
68        "phone": "string",
69        "parentId": 0,
70        "parentName": "string",
71        "parentDisplayId": "string",
72        "companyId": 0,
73        "partnerRoleId": 0,
74        "partnerContactId": 0
75      }
76    ]
77  }
78}

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Project Signature - Delete Project Signature

HTTP Request

DELETE /api/project-signatures/{id}

📋 Description: Deletes a specified project signature from the Nakisa Portfolio Management Suite, facilitating the management of portfolio assets and ensuring accurate analytics within real estate property data.

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

Project Signature - Create Project Signature

HTTP Request

POST /api/project-signatures

📋 Description: Creates a new project signature within the Nakisa Portfolio Management Suite, enabling users to associate critical approvals and documentation with specific portfolio assets in real estate property analytics.

Parameters

Name

In

Type

Required

Description

body

body

ProjectSignatureDto

true

Request body containing the project signature details, including asset identifiers and associated metadata, essential for portfolio management and analytics within the real estate property context.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "level": 0,
10  "approveDate": "2019-08-24",
11  "isApproved": true,
12  "projectId": 0,
13  "userId": 0,
14  "userDto": {
15    "createdBy": "string",
16    "lastModifiedBy": "string",
17    "createdDate": "2019-08-24T14:15:22Z",
18    "lastModifiedDate": "2019-08-24T14:15:22Z",
19    "archived": true,
20    "externalId": "string",
21    "id": 0,
22    "email": "string",
23    "userName": "string",
24    "firstName": "string",
25    "lastName": "string",
26    "displayName": "string",
27    "permissions": "string",
28    "internalId": "string",
29    "preferredCulture": {
30      "createdBy": "string",
31      "lastModifiedBy": "string",
32      "createdDate": "2019-08-24T14:15:22Z",
33      "lastModifiedDate": "2019-08-24T14:15:22Z",
34      "archived": true,
35      "externalId": "string",
36      "id": 0,
37      "name": "string",
38      "code": "string",
39      "defaultCulture": true,
40      "enable": true
41    },
42    "userGroups": [
43      {
44        "createdBy": "string",
45        "lastModifiedBy": "string",
46        "createdDate": "2019-08-24T14:15:22Z",
47        "lastModifiedDate": "2019-08-24T14:15:22Z",
48        "archived": true,
49        "externalId": "string",
50        "id": 0,
51        "name": "string",
52        "description": "string",
53        "internalId": "string"
54      }
55    ],
56    "partnerIds": [
57      0
58    ],
59    "partners": [
60      {
61        "id": 0,
62        "status": "CREATED",
63        "displayId": "string",
64        "erpSystemId": 0,
65        "erpSystemDisplayId": "string",
66        "name": "string",
67        "fax": "string",
68        "phone": "string",
69        "parentId": 0,
70        "parentName": "string",
71        "parentDisplayId": "string",
72        "companyId": 0,
73        "partnerRoleId": 0,
74        "partnerContactId": 0
75      }
76    ]
77  }
78}

Responses

Status

Meaning

Description

Schema

201

Created

Created

integer

Example Responses

10

Project Signature - Get All Project Signatures By Project ID

HTTP Request

GET /api/project-signatures/projects/{projectId}

📋 Description: Retrieves project signature details for a specified project within the Nakisa Portfolio Management Suite, enabling users to access critical information related to portfolio, asset, and real estate property analytics.

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

 1[
 2  {
 3    "createdBy": "string",
 4    "lastModifiedBy": "string",
 5    "createdDate": "2019-08-24T14:15:22Z",
 6    "lastModifiedDate": "2019-08-24T14:15:22Z",
 7    "archived": true,
 8    "externalId": "string",
 9    "id": 0,
10    "level": 0,
11    "approveDate": "2019-08-24",
12    "isApproved": true,
13    "projectId": 0,
14    "userId": 0,
15    "userDto": {
16      "createdBy": "string",
17      "lastModifiedBy": "string",
18      "createdDate": "2019-08-24T14:15:22Z",
19      "lastModifiedDate": "2019-08-24T14:15:22Z",
20      "archived": true,
21      "externalId": "string",
22      "id": 0,
23      "email": "string",
24      "userName": "string",
25      "firstName": "string",
26      "lastName": "string",
27      "displayName": "string",
28      "permissions": "string",
29      "internalId": "string",
30      "preferredCulture": {
31        "createdBy": "string",
32        "lastModifiedBy": "string",
33        "createdDate": "2019-08-24T14:15:22Z",
34        "lastModifiedDate": "2019-08-24T14:15:22Z",
35        "archived": true,
36        "externalId": "string",
37        "id": 0,
38        "name": "string",
39        "code": "string",
40        "defaultCulture": true,
41        "enable": true
42      },
43      "userGroups": [
44        {
45          "createdBy": "string",
46          "lastModifiedBy": "string",
47          "createdDate": "2019-08-24T14:15:22Z",
48          "lastModifiedDate": "2019-08-24T14:15:22Z",
49          "archived": true,
50          "externalId": "string",
51          "id": 0,
52          "name": "string",
53          "description": "string",
54          "internalId": "string"
55        }
56      ],
57      "partnerIds": [
58        0
59      ],
60      "partners": [
61        {
62          "id": 0,
63          "status": "CREATED",
64          "displayId": "string",
65          "erpSystemId": 0,
66          "erpSystemDisplayId": "string",
67          "name": "string",
68          "fax": "string",
69          "phone": "string",
70          "parentId": 0,
71          "parentName": "string",
72          "parentDisplayId": "string",
73          "companyId": 0,
74          "partnerRoleId": 0,
75          "partnerContactId": 0
76        }
77      ]
78    }
79  }
80]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ProjectSignatureDto]

false

none

[Data transfer object representing the signature details associated with a project within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in the context of 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

» level

integer(int32)

false

none

Numeric value representing level

» approveDate

string(date)

false

none

Date of the approve

» isApproved

boolean

false

none

Whether the resource is approved

» projectId

integer(int64)

true

none

Unique identifier for the project

» userId

integer(int64)

false

none

Unique identifier for the user

» userDto

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