Agreement Group

Get

HTTP Request

GET /api/v1/agreement-groups/{id}

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Update

HTTP Request

PUT /api/v1/agreement-groups/{id}

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	none
body	body	AgreementGroupDto	true	none

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Delete

HTTP Request

DELETE /api/v1/agreement-groups/{id}

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Delete Or Decommission

HTTP Request

PUT /api/v1/agreement-groups/remove/{id}

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Delete Or Decommission All

HTTP Request

PUT /api/v1/agreement-groups/remove/bulk

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	none

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Decommission

HTTP Request

PUT /api/v1/agreement-groups/decommission/{id}

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Decommission By Modification Date Before

HTTP Request

PUT /api/v1/agreement-groups/decommission/modified-before/{modified_before}

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Decommission Before Now

HTTP Request

PUT /api/v1/agreement-groups/decommission/modified-before-now

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Decommission All

HTTP Request

PUT /api/v1/agreement-groups/decommission/bulk

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	none

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Create Or Update Bulk

HTTP Request

PUT /api/v1/agreement-groups/createOrUpdate/bulk

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	none

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Create Or Update

HTTP Request

PUT /api/v1/agreement-groups/createOrUpdate

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	none

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Bulk Update

HTTP Request

PUT /api/v1/agreement-groups/bulk

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	none

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Bulk Create

HTTP Request

POST /api/v1/agreement-groups/bulk

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	none

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Bulk Delete

HTTP Request

DELETE /api/v1/agreement-groups/bulk

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	none

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Search

HTTP Request

POST /api/v1/agreement-groups/search

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
body	body	AgreementGroupDtoFilter	false	none

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	PageAgreementGroupDto

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "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

Find All

HTTP Request

GET /api/v1/agreement-groups

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAgreementGroupDto

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "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

Create

HTTP Request

POST /api/v1/agreement-groups

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	none

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAgreementGroupDto

Example Responses

{
  "code": "UPDATED",
  "message": "string",
  "defaultMessage": "string",
  "debugMessage": "string",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "field": "string",
        "errorKey": "string",
        "errorMessage": "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

Get Metadata

HTTP Request

GET /api/v1/agreement-groups/meta

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

---