Contract Group 2

Contract Group - Get

HTTP Request

GET /api/v1/contract-group-2/{id}

Interactive Demo

📋 Description: Retrieves the details of a specific contract group within the financial organization structure, identified by the provided ID, to facilitate understanding of the organization’s hierarchy and financial entity relationships.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Update

HTTP Request

PUT /api/v1/contract-group-2/{id}

Interactive Demo

📋 Description: Updates the details of a specified contract group within the financial organization structure, allowing for modifications to align with organizational hierarchy and financial entity requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ContractGroup2Dto	true	Request body containing the updated details of the contract group, including organizational hierarchy and financial entity attributes, for the specified ID.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Delete

HTTP Request

DELETE /api/v1/contract-group-2/{id}

Interactive Demo

📋 Description: Deletes a specified contract group from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Contract Group - Delete Or Decommission

HTTP Request

PUT /api/v1/contract-group-2/remove/{id}

Interactive Demo

📋 Description: Removes a specified contract group from the financial organization structure, ensuring 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	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Contract Group - Delete Or Decommission All

HTTP Request

PUT /api/v1/contract-group-2/remove/bulk

Interactive Demo

📋 Description: Removes multiple contract groups from the financial organization structure, facilitating the management of organizational hierarchy and ensuring accurate representation of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers to facilitate the bulk removal of contract groups within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Contract Group - Decommission

HTTP Request

PUT /api/v1/contract-group-2/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified contract group within the financial organization structure, effectively removing it from the active hierarchy and ensuring it is no longer utilized in organizational operations.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/contract-group-2/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions contract groups within the financial organization structure that were modified before the specified date, ensuring the hierarchy remains up-to-date and aligned with current business needs.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning contract groups, ensuring that only those modified before this date are processed within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Decommission Before Now

HTTP Request

PUT /api/v1/contract-group-2/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions contract groups within the financial organization structure that were modified before the current date, ensuring the hierarchy remains up-to-date and aligned with organizational changes.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Decommission All

HTTP Request

PUT /api/v1/contract-group-2/decommission/bulk

Interactive Demo

📋 Description: Updates the status of multiple contract groups within the financial organization structure to ‘decommissioned,’ facilitating the management of organizational hierarchy and ensuring accurate representation of active financial entities.

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 for bulk processing within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Create Or Update Bulk

HTTP Request

PUT /api/v1/contract-group-2/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple contract groups within the financial organization structure, ensuring alignment with the specified hierarchy and organizational needs. This operation facilitates efficient management of financial entities by allowing bulk modifications in a single request.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup2Dto	true	Request body containing bulk data for creating or updating contract groups within the financial organization structure, including details on organizational hierarchy and financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Create Or Update

HTTP Request

PUT /api/v1/contract-group-2/createOrUpdate

Interactive Demo

📋 Description: Creates or updates a contract group within the financial organization structure, enabling effective management of organizational hierarchies and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup2Dto	true	Request body containing the financial entity’s contract group details, including organizational hierarchy and structural attributes for creation or update.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Bulk Update

HTTP Request

PUT /api/v1/contract-group-2/bulk

Interactive Demo

📋 Description: Updates multiple contract groups within the financial organization structure, allowing for efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup2Dto	true	Request body containing a bulk update of financial entity contract group data, including hierarchical structure and organizational details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Bulk Create

HTTP Request

POST /api/v1/contract-group-2/bulk

Interactive Demo

📋 Description: Submits a bulk creation request for contract groups within the financial organization structure, enabling efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup2Dto	true	Request body containing a collection of financial entity contract group data, including hierarchical relationships and organizational structure details for bulk processing.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Bulk Delete

HTTP Request

DELETE /api/v1/contract-group-2/bulk

Interactive Demo

📋 Description: Deletes multiple contract groups within the financial organization structure, enabling efficient management of hierarchical relationships and organizational entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of contract group identifiers to facilitate the bulk deletion of financial entity structures within the organization hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Contract Group - Search

HTTP Request

POST /api/v1/contract-group-2/search

Interactive Demo

📋 Description: Submits a search request to retrieve contract groups within the financial organization structure, allowing for targeted queries based on specified criteria.

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	ContractGroup2DtoFilter	false	Request body containing search criteria for financial entity contract groups, including organizational hierarchy and structural parameters.

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",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "uiSelector": "string",
  "nameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageContractGroup2Dto

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,
      "status": "CREATED",
      "displayId": "string",
      "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

Contract Group - Find All

HTTP Request

GET /api/v1/contract-group-2

Interactive Demo

📋 Description: Fetches the contract group hierarchy within the financial organization structure, providing insights into the relationships and classifications of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the contract group retrieval should be paginated, facilitating efficient navigation through the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageContractGroup2Dto

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,
      "status": "CREATED",
      "displayId": "string",
      "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

Contract Group - Create

HTTP Request

POST /api/v1/contract-group-2

Interactive Demo

📋 Description: Creates a new contract group within the financial organization structure, enabling the establishment of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup2Dto	true	Request body containing the hierarchical structure data for the financial organization, including details of the contract group and associated entities.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup2Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Get Metadata

HTTP Request

GET /api/v1/contract-group-2/meta

Interactive Demo

📋 Description: Retrieves metadata related to the financial organization structure, providing insights into the hierarchy and grouping of financial entities within the contract group.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

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

---