Data Creation Setting

Data Creation Setting - Get

HTTP Request

GET /api/v1/data-creation-settings/{id}

Interactive Demo

📋 Description: Retrieves the data creation settings for a specified financial entity, enabling users to understand and manage the organizational structure and hierarchy within the financial organization.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

Data Creation Setting - Update

HTTP Request

PUT /api/v1/data-creation-settings/{id}

Interactive Demo

📋 Description: Updates the data creation settings for a specified financial entity within the organizational hierarchy, allowing for adjustments to the structure and configuration of financial data management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	DataCreationSettingDto	true	Request body containing the updated financial organization structure settings, including hierarchical relationships and attributes for the specified financial entity.

Body Parameters

{
  "id": 0,
  "startDateTime": "2019-08-24T14:15:22Z",
  "endDateTime": "2019-08-24T14:15:22Z",
  "idGenerationType": "AUTO",
  "source": "string",
  "type": "MIGRATION",
  "notes": [
    {
      "id": 0,
      "note": "string"
    }
  ],
  "active": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

Data Creation Setting - Deactivate Data Creation Setting

HTTP Request

PUT /api/v1/data-creation-settings/deactivate/{id}

Interactive Demo

📋 Description: Deactivates the specified data creation settings within the financial organization structure, effectively removing them from active use in the organizational hierarchy. This operation ensures that outdated or unnecessary configurations do not impact the financial entity’s operational integrity.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

Data Creation Setting - Deactivate Migration

HTTP Request

PUT /api/v1/data-creation-settings/deactivate-migration

Interactive Demo

📋 Description: Deactivates the migration process for financial organization structure settings, ensuring that the hierarchy and configuration of financial entities remain stable and intact. This operation is essential for maintaining the integrity of organizational data during structural changes.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

Data Creation Setting - Create Or Update Bulk

HTTP Request

PUT /api/v1/data-creation-settings/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple data creation settings for financial entities within the organizational structure, ensuring alignment with the established hierarchy. This operation facilitates efficient management of configuration settings in bulk, enhancing the overall data governance process.

Parameters

Name	In	Type	Required	Description
body	body	DataCreationSettingDto	true	Request body containing bulk data for creating or updating financial organization structure settings, including hierarchical relationships and attributes of financial entities.

Body Parameters

[
  {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z",
      "idGenerationType": "AUTO",
      "source": "string",
      "type": "MIGRATION",
      "notes": [
        {
          "id": 0,
          "note": "string"
        }
      ],
      "active": true
    }
  ]
}

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

Data Creation Setting - Create Or Update

HTTP Request

PUT /api/v1/data-creation-settings/createOrUpdate

Interactive Demo

📋 Description: Updates or creates data creation settings for the financial organization structure, enabling users to manage the hierarchy and configuration of financial entities effectively.

Parameters

Name	In	Type	Required	Description
body	body	DataCreationSettingDto	true	Request body containing the financial organization structure settings, including details for creating or updating the hierarchy and attributes of financial entities.

Body Parameters

{
  "id": 0,
  "startDateTime": "2019-08-24T14:15:22Z",
  "endDateTime": "2019-08-24T14:15:22Z",
  "idGenerationType": "AUTO",
  "source": "string",
  "type": "MIGRATION",
  "notes": [
    {
      "id": 0,
      "note": "string"
    }
  ],
  "active": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

Data Creation Setting - Bulk Update

HTTP Request

PUT /api/v1/data-creation-settings/bulk

Interactive Demo

📋 Description: Updates multiple data creation settings for financial entities within the organizational structure, allowing for efficient management of hierarchical configurations.

Parameters

Name	In	Type	Required	Description
body	body	DataCreationSettingDto	true	Request body containing bulk financial organization structure settings, including hierarchical relationships and attributes of financial entities.

Body Parameters

[
  {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z",
      "idGenerationType": "AUTO",
      "source": "string",
      "type": "MIGRATION",
      "notes": [
        {
          "id": 0,
          "note": "string"
        }
      ],
      "active": true
    }
  ]
}

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

Data Creation Setting - Search (With Sources And Search)

HTTP Request

POST /api/v1/data-creation-settings/sources/search

Interactive Demo

📋 Description: Submits a request to search for data creation sources within the financial organization structure, enabling users to identify and manage hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the search criteria for financial organization structure sources, including parameters to identify and filter relevant financial entities within the hierarchy.
» filter	body	DataCreationSourceDtoFilter	false	Data transfer object representing the criteria used to filter data creation sources within a financial organization’s structure, facilitating the organization and hierarchy of financial entities.
»» idIn	body	[integer]	false	Filter by multiple values of id
»» idEqual	body	integer(int64)	false	Filter by exact match of id
»» idLike	body	string	false	Filter by partial match of id
»» createdAtGreaterThanOrEqual	body	string(date-time)	false	Filter where created at is greater than or equal to specified value
»» createdAtLessThanOrEqual	body	string(date-time)	false	Filter where created at is less than or equal to specified value
»» createdByLike	body	string	false	Filter by partial match of created by
»» createdByEqual	body	string	false	Filter by exact match of created by
»» modifiedAtGreaterThanOrEqual	body	string(date-time)	false	Filter where modified at is greater than or equal to specified value
»» modifiedAtLessThanOrEqual	body	string(date-time)	false	Filter where modified at is less than or equal to specified value
»» modifiedByLike	body	string	false	Filter by partial match of modified by
»» modifiedByEqual	body	string	false	Filter by exact match of modified by
»» uiSelector	body	string	false	String used to specify the user interface selector for filtering financial entities within the organizational structure hierarchy.
»» nameLike	body	string	false	Filter by partial match of name
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of financial entities within an organization’s hierarchical structure, facilitating efficient retrieval and management of organizational data.
»» page	body	integer(int32)	false	Page number for pagination
»» size	body	integer(int32)	false	Number of items per page
»» sort	body	[string]	false	Sort order specification

Parameter Constraints

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "filter": {
    "idIn": [
      0
    ],
    "idEqual": 0,
    "idLike": "string",
    "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "createdByLike": "string",
    "createdByEqual": "string",
    "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedByLike": "string",
    "modifiedByEqual": "string",
    "uiSelector": "string",
    "nameLike": "string"
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDataCreationSourceDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Data Creation Setting - Search

HTTP Request

POST /api/v1/data-creation-settings/search

Interactive Demo

📋 Description: Submits a request to create or update data creation settings for financial entities within the organization structure, enabling efficient management of hierarchical relationships.

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	DataCreationSettingDtoFilter	false	Request body containing the financial entity hierarchy data and associated parameters for configuring organization structure settings.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "startDateTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "startDateTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
  "endDateTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "endDateTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
  "idGenerationTypeEqual": "AUTO",
  "sourceLike": "string",
  "typeEqual": "MIGRATION"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDataCreationSettingDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z",
      "idGenerationType": "AUTO",
      "source": "string",
      "type": "MIGRATION",
      "notes": [
        {
          "id": 0,
          "note": "string"
        }
      ],
      "active": true
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Data Creation Setting - Add Note To Active Setting

HTTP Request

POST /api/v1/data-creation-settings/add-note-to-active-setting

Interactive Demo

📋 Description: Adds a note to the currently active financial organization structure setting, enabling users to document important information related to the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
note	query	string	true	Textual note to provide additional context or details related to the active financial entity setting within the organization’s structure and hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

Data Creation Setting - Add Note

HTTP Request

POST /api/v1/data-creation-settings/add-note

Interactive Demo

📋 Description: Adds a note to the data creation settings within the financial organization structure, facilitating enhanced documentation and clarity regarding the hierarchy and relationships of financial entities.

Parameters

Name	In	Type	Required	Description
id	query	integer(int64)	true	Unique identifier for the resource
note	query	string	true	Textual note associated with the financial organization structure, used to provide additional context or details during the data creation process.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

Data Creation Setting - Activate Migration

HTTP Request

POST /api/v1/data-creation-settings/activate-migration

Interactive Demo

📋 Description: Activates the migration process for financial organization structure settings, enabling the transition of hierarchical data for enhanced management of financial entities.

Parameters

Name	In	Type	Required	Description
source	query	string	true	Specifies the origin of the migration request, indicating the financial entity or organizational structure to be activated within the system.
idGenerationType	query	string	false	Type of the id generation
endDateTime	query	string(date-time)	false	Time of the end date

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

Data Creation Setting - Find All

HTTP Request

GET /api/v1/data-creation-settings

Interactive Demo

📋 Description: Retrieves the data creation settings for the financial organization structure, providing insights into the hierarchy and configuration of financial entities within the system. This operation ensures users have access to the necessary settings for effective organizational management.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of financial organization structure data within the specified hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDataCreationSettingDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "startDateTime": "2019-08-24T14:15:22Z",
      "endDateTime": "2019-08-24T14:15:22Z",
      "idGenerationType": "AUTO",
      "source": "string",
      "type": "MIGRATION",
      "notes": [
        {
          "id": 0,
          "note": "string"
        }
      ],
      "active": true
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Data Creation Setting - Create

HTTP Request

POST /api/v1/data-creation-settings

Interactive Demo

📋 Description: Creates new data creation settings for the financial organization structure, enabling the configuration of hierarchical relationships and organizational entities within the financial framework.

Parameters

Name	In	Type	Required	Description
body	body	DataCreationSettingDto	true	Request body containing the financial organization structure settings, including hierarchy details and associated metadata for effective data creation.

Body Parameters

{
  "id": 0,
  "startDateTime": "2019-08-24T14:15:22Z",
  "endDateTime": "2019-08-24T14:15:22Z",
  "idGenerationType": "AUTO",
  "source": "string",
  "type": "MIGRATION",
  "notes": [
    {
      "id": 0,
      "note": "string"
    }
  ],
  "active": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

Data Creation Setting - Get Active Data Creation Setting

HTTP Request

GET /api/v1/data-creation-settings/fetch-active

Interactive Demo

📋 Description: Fetches the active data creation settings for the financial organization structure, enabling users to understand the current hierarchy and configuration of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDataCreationSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "idGenerationType": "AUTO",
    "source": "string",
    "type": "MIGRATION",
    "notes": [
      {
        "id": 0,
        "note": "string"
      }
    ],
    "active": true
  }
}

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

---