CISO Assistant API — Third-Party Risk Management (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

contracts

contracts_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

beneficiary_entity	Array of strings <uuid> [ items <uuid > ]
currency	Array of strings Items Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNH" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XCD" "XPF" "YER" "ZAR" "ZMK" "ZMW" "ZWL" "x46" Currency for contract expenses `AED` - UAE Dirham `AFN` - Afghani `ALL` - Lek `AMD` - Armenian Dram `ANG` - Netherlands Antillean Guilder `AOA` - Kwanza `ARS` - Argentine Peso `AUD` - Australian Dollar `AWG` - Aruban Florin `AZN` - Azerbaijanian Manat `BAM` - Convertible Mark `BBD` - Barbados Dollar `BDT` - Taka `BGN` - Bulgarian Lev `BHD` - Bahraini Dinar `BIF` - Burundi Franc `BMD` - Bermudian Dollar `BND` - Brunei Dollar `BOB` - Boliviano `BOV` - Mvdol `BRL` - Brazilian Real `BSD` - Bahamian Dollar `BTN` - Ngultrum `BWP` - Pula `BYR` - Belarussian Ruble (2000 Series) `BYN` - Belarusian Ruble `BZD` - Belize Dollar `CAD` - Canadian Dollar `CDF` - Congolese Franc `CHE` - WIR Euro `CHF` - Swiss Franc `CHW` - WIR Franc `CLF` - Unidades de fomento `CLP` - Chilean Peso `CNY` - Yuan Renminbi `COP` - Colombian Peso `COU` - Unidad de Valor Real `CRC` - Costa Rican Colon `CUC` - Peso Convertible `CUP` - Cuban Peso `CVE` - Cape Verde Escudo `CZK` - Czech Koruna `DJF` - Djibouti Franc `DKK` - Danish Krone `DOP` - Dominican Peso `DZD` - Algerian Dinar `EGP` - Egyptian Pound `ERN` - Nakfa `ETB` - Ethiopian Birr `EUR` - Euro `FJD` - Fiji Dollar `FKP` - Falkland Islands Pound `GBP` - Pound Sterling `GEL` - Lari `GHS` - Ghana Cedi `GIP` - Gibraltar Pound `GMD` - Dalasi `GNF` - Guinea Franc `GTQ` - Quetzal `GYD` - Guyana Dollar `HKD` - Hong Kong Dollar `HNL` - Lempira `HTG` - Gourde `HUF` - Forint `IDR` - Rupiah `ILS` - New Israeli Sheqel `INR` - Indian Rupee `IQD` - Iraqi Dinar `IRR` - Iranian Rial `ISK` - Iceland Krona `JMD` - Jamaican Dollar `JOD` - Jordanian Dinar `JPY` - Yen `KES` - Kenyan Shilling `KGS` - Som `KHR` - Riel `KMF` - Comoro Franc `KPW` - North Korean Won `KRW` - Won `KWD` - Kuwaiti Dinar `KYD` - Cayman Islands Dollar `KZT` - Tenge `LAK` - Kip `LBP` - Lebanese Pound `LKR` - Sri Lanka Rupee `LRD` - Liberian Dollar `LSL` - Loti `LTL` - Lithuanian Litas `LVL` - Latvian Lats `LYD` - Libyan Dinar `MAD` - Moroccan Dirham `MDL` - Moldovan Leu `MGA` - Malagasy Ariary `MKD` - Denar `MMK` - Kyat `MNT` - Tugrik `MOP` - Pataca `MRO` - Ouguiya `MUR` - Mauritius Rupee `MVR` - Rufiyaa `MWK` - Kwacha `MXN` - Mexican Peso `MYR` - Malaysian Ringgit `MZN` - Mozambique Metical `NAD` - Namibia Dollar `NGN` - Naira `NIO` - Cordoba Oro `NOK` - Norwegian Krone `NPR` - Nepalese Rupee `NZD` - New Zealand Dollar `OMR` - Rial Omani `PAB` - Balboa `PEN` - Nuevo Sol `PGK` - Kina `PHP` - Philippine Peso `PKR` - Pakistan Rupee `PLN` - Zloty `PYG` - Guarani `QAR` - Qatari Rial `RON` - New Romanian Leu `RSD` - Serbian Dinar `RUB` - Russian Ruble `RWF` - Rwanda Franc `SAR` - Saudi Riyal `SBD` - Solomon Islands Dollar `SCR` - Seychelles Rupee `SDG` - Sudanese Pound `SEK` - Swedish Krona `SGD` - Singapore Dollar `SHP` - Saint Helena Pound `SLL` - Leone `SOS` - Somali Shilling `SRD` - Surinam Dollar `SSP` - South Sudanese Pound `STD` - Dobra `SVC` - El Salvador Colon `SYP` - Syrian Pound `SZL` - Lilangeni `THB` - Baht `TJS` - Somoni `TMT` - Turkmenistan New Manat `TND` - Tunisian Dinar `TOP` - Pa'anga `TRY` - Turkish Lira `TTD` - Trinidad and Tobago Dollar `TWD` - New Taiwan Dollar `TZS` - Tanzanian Shilling `UAH` - Hryvnia `UGX` - Uganda Shilling `USD` - US Dollar `UYI` - Uruguay Peso en Unidades Indexadas (URUIURUI) `UYU` - Peso Uruguayo `UZS` - Uzbekistan Sum `VEF` - Bolivar `VND` - Dong `VUV` - Vatu `WST` - Tala `XCD` - East Caribbean Dollar `YER` - Yemeni Rial `ZAR` - Rand `ZMK` - Zambian Kwacha (replaced January 1, 2013) `ZMW` - Zambian Kwacha `ZWL` - Zimbabwe Dollar `x46` - Other Currency (open axis tables) `XPF` - CFP Franc `CNH` - Off-shore Yuan Renminbi
dora_contractual_arrangement	Array of strings Items Enum: "eba_CO:x1" "eba_CO:x2" "eba_CO:x3" DORA contractual arrangement type `eba_CO:x1` - Standalone arrangement `eba_CO:x2` - Overarching arrangement `eba_CO:x3` - Subsequent or associated arrangement
end_date	string <date>
folder	Array of strings <uuid> [ items <uuid > ]
governing_law_country	Array of strings Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW" "x28" Country whose law governs this contract `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
is_intragroup	boolean
limit	integer Number of results to return per page.
name	string
notice_period_entity	integer
notice_period_provider	integer
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
overarching_contract	Array of strings <uuid> [ items <uuid > ]
owner	Array of strings <uuid> [ items <uuid > ]
provider_entity	Array of strings <uuid> [ items <uuid > ]
search	string A search term.
solutions	Array of strings <uuid> [ items <uuid > ]
status	Array of strings Items Enum: "active" "draft" "expired" "terminated" `draft` - Draft `active` - Active `expired` - Expired `terminated` - Terminated
termination_reason	Array of strings Items Enum: "eba_CO:x4" "eba_CO:x5" "eba_CO:x6" "eba_CO:x7" "eba_CO:x8" "eba_CO:x9" Reason for contract termination `eba_CO:x4` - Termination not for cause: Expired and not renewed `eba_CO:x5` - Termination for cause: Provider in breach of applicable law, regulations or contractual provisions `eba_CO:x6` - Termination for cause: Identified impediments of the provider capable of altering the supported function `eba_CO:x7` - Termination for cause: Provider's weaknesses regarding the management and security of sensitive data or information `eba_CO:x8` - Termination: As requested by the competent authority `eba_CO:x9` - Other reasons for termination

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"folder": "string",
"owner": ["string"
],
"provider_entity": "string",
"beneficiary_entity": "string",
"evidences": ["string"
],
"solutions": ["string"
],
"overarching_contract": "string",
"filtering_labels": ["string"
],
"validation_flows": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"status": "draft",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"ref_id": "string",
"dora_contractual_arrangement": "eba_CO:x1",
"currency": "AED",
"annual_expense": 0.1,
"termination_reason": "eba_CO:x4",
"is_intragroup": true,
"dora_exclude": true,
"governing_law_country": "AF",
"notice_period_entity": -9223372036854776000,
"notice_period_provider": -9223372036854776000
}
]
}

contracts_create

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
status	string (StatusF8fEnum) Enum: "draft" "active" "expired" "terminated" `draft` - Draft `active` - Active `expired` - Expired `terminated` - Terminated
start_date	string or null <date>
end_date	string or null <date>
ref_id	string (Reference ID) <= 255 characters Contract reference number or identifier
dora_contractual_arrangement	string Enum: "eba_CO:x1" "eba_CO:x2" "eba_CO:x3" DORA contractual arrangement type `eba_CO:x1` - Standalone arrangement `eba_CO:x2` - Overarching arrangement `eba_CO:x3` - Subsequent or associated arrangement
	CurrencyEnum (string) or BlankEnum (any) Currency for contract expenses `AED` - UAE Dirham `AFN` - Afghani `ALL` - Lek `AMD` - Armenian Dram `ANG` - Netherlands Antillean Guilder `AOA` - Kwanza `ARS` - Argentine Peso `AUD` - Australian Dollar `AWG` - Aruban Florin `AZN` - Azerbaijanian Manat `BAM` - Convertible Mark `BBD` - Barbados Dollar `BDT` - Taka `BGN` - Bulgarian Lev `BHD` - Bahraini Dinar `BIF` - Burundi Franc `BMD` - Bermudian Dollar `BND` - Brunei Dollar `BOB` - Boliviano `BOV` - Mvdol `BRL` - Brazilian Real `BSD` - Bahamian Dollar `BTN` - Ngultrum `BWP` - Pula `BYR` - Belarussian Ruble (2000 Series) `BYN` - Belarusian Ruble `BZD` - Belize Dollar `CAD` - Canadian Dollar `CDF` - Congolese Franc `CHE` - WIR Euro `CHF` - Swiss Franc `CHW` - WIR Franc `CLF` - Unidades de fomento `CLP` - Chilean Peso `CNY` - Yuan Renminbi `COP` - Colombian Peso `COU` - Unidad de Valor Real `CRC` - Costa Rican Colon `CUC` - Peso Convertible `CUP` - Cuban Peso `CVE` - Cape Verde Escudo `CZK` - Czech Koruna `DJF` - Djibouti Franc `DKK` - Danish Krone `DOP` - Dominican Peso `DZD` - Algerian Dinar `EGP` - Egyptian Pound `ERN` - Nakfa `ETB` - Ethiopian Birr `EUR` - Euro `FJD` - Fiji Dollar `FKP` - Falkland Islands Pound `GBP` - Pound Sterling `GEL` - Lari `GHS` - Ghana Cedi `GIP` - Gibraltar Pound `GMD` - Dalasi `GNF` - Guinea Franc `GTQ` - Quetzal `GYD` - Guyana Dollar `HKD` - Hong Kong Dollar `HNL` - Lempira `HTG` - Gourde `HUF` - Forint `IDR` - Rupiah `ILS` - New Israeli Sheqel `INR` - Indian Rupee `IQD` - Iraqi Dinar `IRR` - Iranian Rial `ISK` - Iceland Krona `JMD` - Jamaican Dollar `JOD` - Jordanian Dinar `JPY` - Yen `KES` - Kenyan Shilling `KGS` - Som `KHR` - Riel `KMF` - Comoro Franc `KPW` - North Korean Won `KRW` - Won `KWD` - Kuwaiti Dinar `KYD` - Cayman Islands Dollar `KZT` - Tenge `LAK` - Kip `LBP` - Lebanese Pound `LKR` - Sri Lanka Rupee `LRD` - Liberian Dollar `LSL` - Loti `LTL` - Lithuanian Litas `LVL` - Latvian Lats `LYD` - Libyan Dinar `MAD` - Moroccan Dirham `MDL` - Moldovan Leu `MGA` - Malagasy Ariary `MKD` - Denar `MMK` - Kyat `MNT` - Tugrik `MOP` - Pataca `MRO` - Ouguiya `MUR` - Mauritius Rupee `MVR` - Rufiyaa `MWK` - Kwacha `MXN` - Mexican Peso `MYR` - Malaysian Ringgit `MZN` - Mozambique Metical `NAD` - Namibia Dollar `NGN` - Naira `NIO` - Cordoba Oro `NOK` - Norwegian Krone `NPR` - Nepalese Rupee `NZD` - New Zealand Dollar `OMR` - Rial Omani `PAB` - Balboa `PEN` - Nuevo Sol `PGK` - Kina `PHP` - Philippine Peso `PKR` - Pakistan Rupee `PLN` - Zloty `PYG` - Guarani `QAR` - Qatari Rial `RON` - New Romanian Leu `RSD` - Serbian Dinar `RUB` - Russian Ruble `RWF` - Rwanda Franc `SAR` - Saudi Riyal `SBD` - Solomon Islands Dollar `SCR` - Seychelles Rupee `SDG` - Sudanese Pound `SEK` - Swedish Krona `SGD` - Singapore Dollar `SHP` - Saint Helena Pound `SLL` - Leone `SOS` - Somali Shilling `SRD` - Surinam Dollar `SSP` - South Sudanese Pound `STD` - Dobra `SVC` - El Salvador Colon `SYP` - Syrian Pound `SZL` - Lilangeni `THB` - Baht `TJS` - Somoni `TMT` - Turkmenistan New Manat `TND` - Tunisian Dinar `TOP` - Pa'anga `TRY` - Turkish Lira `TTD` - Trinidad and Tobago Dollar `TWD` - New Taiwan Dollar `TZS` - Tanzanian Shilling `UAH` - Hryvnia `UGX` - Uganda Shilling `USD` - US Dollar `UYI` - Uruguay Peso en Unidades Indexadas (URUIURUI) `UYU` - Peso Uruguayo `UZS` - Uzbekistan Sum `VEF` - Bolivar `VND` - Dong `VUV` - Vatu `WST` - Tala `XCD` - East Caribbean Dollar `YER` - Yemeni Rial `ZAR` - Rand `ZMK` - Zambian Kwacha (replaced January 1, 2013) `ZMW` - Zambian Kwacha `ZWL` - Zimbabwe Dollar `x46` - Other Currency (open axis tables) `XPF` - CFP Franc `CNH` - Off-shore Yuan Renminbi
annual_expense	number or null <double> Annual expense amount for this contract
	TerminationReasonEnum (string) or BlankEnum (any) Reason for contract termination `eba_CO:x4` - Termination not for cause: Expired and not renewed `eba_CO:x5` - Termination for cause: Provider in breach of applicable law, regulations or contractual provisions `eba_CO:x6` - Termination for cause: Identified impediments of the provider capable of altering the supported function `eba_CO:x7` - Termination for cause: Provider's weaknesses regarding the management and security of sensitive data or information `eba_CO:x8` - Termination: As requested by the competent authority `eba_CO:x9` - Other reasons for termination
is_intragroup	boolean Whether this is an intragroup contract
dora_exclude	boolean (Exclude from DORA) Exclude this contract from DORA RoI reporting
	GoverningLawCountryEnum (string) or BlankEnum (any) Country whose law governs this contract `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
notice_period_entity	integer or null <int64> (Notice period for entity (days)) [ -9223372036854776000 .. 9223372036854776000 ] Notice period in days for the financial entity
notice_period_provider	integer or null <int64> (Notice period for provider (days)) [ -9223372036854776000 .. 9223372036854776000 ] Notice period in days for the ICT third-party service provider
folder	string <uuid>
provider_entity	string or null <uuid> Entity providing this contract
beneficiary_entity	string or null <uuid> Entity benefiting from/receiving this contract
overarching_contract	string or null <uuid> Parent/overarching contract if this is a subordinate arrangement
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]
owner	Array of strings <uuid> [ items <uuid > ]
evidences	Array of strings <uuid> [ items <uuid > ] Supporting evidence for this contract
solutions	Array of strings <uuid> [ items <uuid > ] Solutions covered by this contract

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"status": "draft",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"ref_id": "string",
"dora_contractual_arrangement": "eba_CO:x1",
"currency": "AED",
"annual_expense": 0.1,
"termination_reason": "eba_CO:x4",
"is_intragroup": true,
"dora_exclude": true,
"governing_law_country": "AF",
"notice_period_entity": -9223372036854776000,
"notice_period_provider": -9223372036854776000,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"beneficiary_entity": "bff50a6d-bbda-4436-8381-7e09feff0bf4",
"overarching_contract": "3eb9b23f-502b-4d69-93fe-d54b4a33a902",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"evidences": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"status": "draft",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"ref_id": "string",
"dora_contractual_arrangement": "eba_CO:x1",
"currency": "AED",
"annual_expense": 0.1,
"termination_reason": "eba_CO:x4",
"is_intragroup": true,
"dora_exclude": true,
"governing_law_country": "AF",
"notice_period_entity": -9223372036854776000,
"notice_period_provider": -9223372036854776000,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"beneficiary_entity": "bff50a6d-bbda-4436-8381-7e09feff0bf4",
"overarching_contract": "3eb9b23f-502b-4d69-93fe-d54b4a33a902",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"evidences": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

contracts_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Contract.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"folder": "string",
"owner": ["string"
],
"provider_entity": "string",
"beneficiary_entity": "string",
"evidences": ["string"
],
"solutions": ["string"
],
"overarching_contract": "string",
"filtering_labels": ["string"
],
"validation_flows": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"status": "draft",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"ref_id": "string",
"dora_contractual_arrangement": "eba_CO:x1",
"currency": "AED",
"annual_expense": 0.1,
"termination_reason": "eba_CO:x4",
"is_intragroup": true,
"dora_exclude": true,
"governing_law_country": "AF",
"notice_period_entity": -9223372036854776000,
"notice_period_provider": -9223372036854776000
}

contracts_update

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Contract.

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
status	string (StatusF8fEnum) Enum: "draft" "active" "expired" "terminated" `draft` - Draft `active` - Active `expired` - Expired `terminated` - Terminated
start_date	string or null <date>
end_date	string or null <date>
ref_id	string (Reference ID) <= 255 characters Contract reference number or identifier
dora_contractual_arrangement	string Enum: "eba_CO:x1" "eba_CO:x2" "eba_CO:x3" DORA contractual arrangement type `eba_CO:x1` - Standalone arrangement `eba_CO:x2` - Overarching arrangement `eba_CO:x3` - Subsequent or associated arrangement
	CurrencyEnum (string) or BlankEnum (any) Currency for contract expenses `AED` - UAE Dirham `AFN` - Afghani `ALL` - Lek `AMD` - Armenian Dram `ANG` - Netherlands Antillean Guilder `AOA` - Kwanza `ARS` - Argentine Peso `AUD` - Australian Dollar `AWG` - Aruban Florin `AZN` - Azerbaijanian Manat `BAM` - Convertible Mark `BBD` - Barbados Dollar `BDT` - Taka `BGN` - Bulgarian Lev `BHD` - Bahraini Dinar `BIF` - Burundi Franc `BMD` - Bermudian Dollar `BND` - Brunei Dollar `BOB` - Boliviano `BOV` - Mvdol `BRL` - Brazilian Real `BSD` - Bahamian Dollar `BTN` - Ngultrum `BWP` - Pula `BYR` - Belarussian Ruble (2000 Series) `BYN` - Belarusian Ruble `BZD` - Belize Dollar `CAD` - Canadian Dollar `CDF` - Congolese Franc `CHE` - WIR Euro `CHF` - Swiss Franc `CHW` - WIR Franc `CLF` - Unidades de fomento `CLP` - Chilean Peso `CNY` - Yuan Renminbi `COP` - Colombian Peso `COU` - Unidad de Valor Real `CRC` - Costa Rican Colon `CUC` - Peso Convertible `CUP` - Cuban Peso `CVE` - Cape Verde Escudo `CZK` - Czech Koruna `DJF` - Djibouti Franc `DKK` - Danish Krone `DOP` - Dominican Peso `DZD` - Algerian Dinar `EGP` - Egyptian Pound `ERN` - Nakfa `ETB` - Ethiopian Birr `EUR` - Euro `FJD` - Fiji Dollar `FKP` - Falkland Islands Pound `GBP` - Pound Sterling `GEL` - Lari `GHS` - Ghana Cedi `GIP` - Gibraltar Pound `GMD` - Dalasi `GNF` - Guinea Franc `GTQ` - Quetzal `GYD` - Guyana Dollar `HKD` - Hong Kong Dollar `HNL` - Lempira `HTG` - Gourde `HUF` - Forint `IDR` - Rupiah `ILS` - New Israeli Sheqel `INR` - Indian Rupee `IQD` - Iraqi Dinar `IRR` - Iranian Rial `ISK` - Iceland Krona `JMD` - Jamaican Dollar `JOD` - Jordanian Dinar `JPY` - Yen `KES` - Kenyan Shilling `KGS` - Som `KHR` - Riel `KMF` - Comoro Franc `KPW` - North Korean Won `KRW` - Won `KWD` - Kuwaiti Dinar `KYD` - Cayman Islands Dollar `KZT` - Tenge `LAK` - Kip `LBP` - Lebanese Pound `LKR` - Sri Lanka Rupee `LRD` - Liberian Dollar `LSL` - Loti `LTL` - Lithuanian Litas `LVL` - Latvian Lats `LYD` - Libyan Dinar `MAD` - Moroccan Dirham `MDL` - Moldovan Leu `MGA` - Malagasy Ariary `MKD` - Denar `MMK` - Kyat `MNT` - Tugrik `MOP` - Pataca `MRO` - Ouguiya `MUR` - Mauritius Rupee `MVR` - Rufiyaa `MWK` - Kwacha `MXN` - Mexican Peso `MYR` - Malaysian Ringgit `MZN` - Mozambique Metical `NAD` - Namibia Dollar `NGN` - Naira `NIO` - Cordoba Oro `NOK` - Norwegian Krone `NPR` - Nepalese Rupee `NZD` - New Zealand Dollar `OMR` - Rial Omani `PAB` - Balboa `PEN` - Nuevo Sol `PGK` - Kina `PHP` - Philippine Peso `PKR` - Pakistan Rupee `PLN` - Zloty `PYG` - Guarani `QAR` - Qatari Rial `RON` - New Romanian Leu `RSD` - Serbian Dinar `RUB` - Russian Ruble `RWF` - Rwanda Franc `SAR` - Saudi Riyal `SBD` - Solomon Islands Dollar `SCR` - Seychelles Rupee `SDG` - Sudanese Pound `SEK` - Swedish Krona `SGD` - Singapore Dollar `SHP` - Saint Helena Pound `SLL` - Leone `SOS` - Somali Shilling `SRD` - Surinam Dollar `SSP` - South Sudanese Pound `STD` - Dobra `SVC` - El Salvador Colon `SYP` - Syrian Pound `SZL` - Lilangeni `THB` - Baht `TJS` - Somoni `TMT` - Turkmenistan New Manat `TND` - Tunisian Dinar `TOP` - Pa'anga `TRY` - Turkish Lira `TTD` - Trinidad and Tobago Dollar `TWD` - New Taiwan Dollar `TZS` - Tanzanian Shilling `UAH` - Hryvnia `UGX` - Uganda Shilling `USD` - US Dollar `UYI` - Uruguay Peso en Unidades Indexadas (URUIURUI) `UYU` - Peso Uruguayo `UZS` - Uzbekistan Sum `VEF` - Bolivar `VND` - Dong `VUV` - Vatu `WST` - Tala `XCD` - East Caribbean Dollar `YER` - Yemeni Rial `ZAR` - Rand `ZMK` - Zambian Kwacha (replaced January 1, 2013) `ZMW` - Zambian Kwacha `ZWL` - Zimbabwe Dollar `x46` - Other Currency (open axis tables) `XPF` - CFP Franc `CNH` - Off-shore Yuan Renminbi
annual_expense	number or null <double> Annual expense amount for this contract
	TerminationReasonEnum (string) or BlankEnum (any) Reason for contract termination `eba_CO:x4` - Termination not for cause: Expired and not renewed `eba_CO:x5` - Termination for cause: Provider in breach of applicable law, regulations or contractual provisions `eba_CO:x6` - Termination for cause: Identified impediments of the provider capable of altering the supported function `eba_CO:x7` - Termination for cause: Provider's weaknesses regarding the management and security of sensitive data or information `eba_CO:x8` - Termination: As requested by the competent authority `eba_CO:x9` - Other reasons for termination
is_intragroup	boolean Whether this is an intragroup contract
dora_exclude	boolean (Exclude from DORA) Exclude this contract from DORA RoI reporting
	GoverningLawCountryEnum (string) or BlankEnum (any) Country whose law governs this contract `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
notice_period_entity	integer or null <int64> (Notice period for entity (days)) [ -9223372036854776000 .. 9223372036854776000 ] Notice period in days for the financial entity
notice_period_provider	integer or null <int64> (Notice period for provider (days)) [ -9223372036854776000 .. 9223372036854776000 ] Notice period in days for the ICT third-party service provider
folder	string <uuid>
provider_entity	string or null <uuid> Entity providing this contract
beneficiary_entity	string or null <uuid> Entity benefiting from/receiving this contract
overarching_contract	string or null <uuid> Parent/overarching contract if this is a subordinate arrangement
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]
owner	Array of strings <uuid> [ items <uuid > ]
evidences	Array of strings <uuid> [ items <uuid > ] Supporting evidence for this contract
solutions	Array of strings <uuid> [ items <uuid > ] Solutions covered by this contract

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"status": "draft",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"ref_id": "string",
"dora_contractual_arrangement": "eba_CO:x1",
"currency": "AED",
"annual_expense": 0.1,
"termination_reason": "eba_CO:x4",
"is_intragroup": true,
"dora_exclude": true,
"governing_law_country": "AF",
"notice_period_entity": -9223372036854776000,
"notice_period_provider": -9223372036854776000,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"beneficiary_entity": "bff50a6d-bbda-4436-8381-7e09feff0bf4",
"overarching_contract": "3eb9b23f-502b-4d69-93fe-d54b4a33a902",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"evidences": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"status": "draft",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"ref_id": "string",
"dora_contractual_arrangement": "eba_CO:x1",
"currency": "AED",
"annual_expense": 0.1,
"termination_reason": "eba_CO:x4",
"is_intragroup": true,
"dora_exclude": true,
"governing_law_country": "AF",
"notice_period_entity": -9223372036854776000,
"notice_period_provider": -9223372036854776000,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"beneficiary_entity": "bff50a6d-bbda-4436-8381-7e09feff0bf4",
"overarching_contract": "3eb9b23f-502b-4d69-93fe-d54b4a33a902",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"evidences": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

contracts_partial_update

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Contract.

Request Body schema:
application/json

is_published	boolean (Published)
name	string <= 200 characters
description	string or null
status	string (StatusF8fEnum) Enum: "draft" "active" "expired" "terminated" `draft` - Draft `active` - Active `expired` - Expired `terminated` - Terminated
start_date	string or null <date>
end_date	string or null <date>
ref_id	string (Reference ID) <= 255 characters Contract reference number or identifier
dora_contractual_arrangement	string Enum: "eba_CO:x1" "eba_CO:x2" "eba_CO:x3" DORA contractual arrangement type `eba_CO:x1` - Standalone arrangement `eba_CO:x2` - Overarching arrangement `eba_CO:x3` - Subsequent or associated arrangement
	CurrencyEnum (string) or BlankEnum (any) Currency for contract expenses `AED` - UAE Dirham `AFN` - Afghani `ALL` - Lek `AMD` - Armenian Dram `ANG` - Netherlands Antillean Guilder `AOA` - Kwanza `ARS` - Argentine Peso `AUD` - Australian Dollar `AWG` - Aruban Florin `AZN` - Azerbaijanian Manat `BAM` - Convertible Mark `BBD` - Barbados Dollar `BDT` - Taka `BGN` - Bulgarian Lev `BHD` - Bahraini Dinar `BIF` - Burundi Franc `BMD` - Bermudian Dollar `BND` - Brunei Dollar `BOB` - Boliviano `BOV` - Mvdol `BRL` - Brazilian Real `BSD` - Bahamian Dollar `BTN` - Ngultrum `BWP` - Pula `BYR` - Belarussian Ruble (2000 Series) `BYN` - Belarusian Ruble `BZD` - Belize Dollar `CAD` - Canadian Dollar `CDF` - Congolese Franc `CHE` - WIR Euro `CHF` - Swiss Franc `CHW` - WIR Franc `CLF` - Unidades de fomento `CLP` - Chilean Peso `CNY` - Yuan Renminbi `COP` - Colombian Peso `COU` - Unidad de Valor Real `CRC` - Costa Rican Colon `CUC` - Peso Convertible `CUP` - Cuban Peso `CVE` - Cape Verde Escudo `CZK` - Czech Koruna `DJF` - Djibouti Franc `DKK` - Danish Krone `DOP` - Dominican Peso `DZD` - Algerian Dinar `EGP` - Egyptian Pound `ERN` - Nakfa `ETB` - Ethiopian Birr `EUR` - Euro `FJD` - Fiji Dollar `FKP` - Falkland Islands Pound `GBP` - Pound Sterling `GEL` - Lari `GHS` - Ghana Cedi `GIP` - Gibraltar Pound `GMD` - Dalasi `GNF` - Guinea Franc `GTQ` - Quetzal `GYD` - Guyana Dollar `HKD` - Hong Kong Dollar `HNL` - Lempira `HTG` - Gourde `HUF` - Forint `IDR` - Rupiah `ILS` - New Israeli Sheqel `INR` - Indian Rupee `IQD` - Iraqi Dinar `IRR` - Iranian Rial `ISK` - Iceland Krona `JMD` - Jamaican Dollar `JOD` - Jordanian Dinar `JPY` - Yen `KES` - Kenyan Shilling `KGS` - Som `KHR` - Riel `KMF` - Comoro Franc `KPW` - North Korean Won `KRW` - Won `KWD` - Kuwaiti Dinar `KYD` - Cayman Islands Dollar `KZT` - Tenge `LAK` - Kip `LBP` - Lebanese Pound `LKR` - Sri Lanka Rupee `LRD` - Liberian Dollar `LSL` - Loti `LTL` - Lithuanian Litas `LVL` - Latvian Lats `LYD` - Libyan Dinar `MAD` - Moroccan Dirham `MDL` - Moldovan Leu `MGA` - Malagasy Ariary `MKD` - Denar `MMK` - Kyat `MNT` - Tugrik `MOP` - Pataca `MRO` - Ouguiya `MUR` - Mauritius Rupee `MVR` - Rufiyaa `MWK` - Kwacha `MXN` - Mexican Peso `MYR` - Malaysian Ringgit `MZN` - Mozambique Metical `NAD` - Namibia Dollar `NGN` - Naira `NIO` - Cordoba Oro `NOK` - Norwegian Krone `NPR` - Nepalese Rupee `NZD` - New Zealand Dollar `OMR` - Rial Omani `PAB` - Balboa `PEN` - Nuevo Sol `PGK` - Kina `PHP` - Philippine Peso `PKR` - Pakistan Rupee `PLN` - Zloty `PYG` - Guarani `QAR` - Qatari Rial `RON` - New Romanian Leu `RSD` - Serbian Dinar `RUB` - Russian Ruble `RWF` - Rwanda Franc `SAR` - Saudi Riyal `SBD` - Solomon Islands Dollar `SCR` - Seychelles Rupee `SDG` - Sudanese Pound `SEK` - Swedish Krona `SGD` - Singapore Dollar `SHP` - Saint Helena Pound `SLL` - Leone `SOS` - Somali Shilling `SRD` - Surinam Dollar `SSP` - South Sudanese Pound `STD` - Dobra `SVC` - El Salvador Colon `SYP` - Syrian Pound `SZL` - Lilangeni `THB` - Baht `TJS` - Somoni `TMT` - Turkmenistan New Manat `TND` - Tunisian Dinar `TOP` - Pa'anga `TRY` - Turkish Lira `TTD` - Trinidad and Tobago Dollar `TWD` - New Taiwan Dollar `TZS` - Tanzanian Shilling `UAH` - Hryvnia `UGX` - Uganda Shilling `USD` - US Dollar `UYI` - Uruguay Peso en Unidades Indexadas (URUIURUI) `UYU` - Peso Uruguayo `UZS` - Uzbekistan Sum `VEF` - Bolivar `VND` - Dong `VUV` - Vatu `WST` - Tala `XCD` - East Caribbean Dollar `YER` - Yemeni Rial `ZAR` - Rand `ZMK` - Zambian Kwacha (replaced January 1, 2013) `ZMW` - Zambian Kwacha `ZWL` - Zimbabwe Dollar `x46` - Other Currency (open axis tables) `XPF` - CFP Franc `CNH` - Off-shore Yuan Renminbi
annual_expense	number or null <double> Annual expense amount for this contract
	TerminationReasonEnum (string) or BlankEnum (any) Reason for contract termination `eba_CO:x4` - Termination not for cause: Expired and not renewed `eba_CO:x5` - Termination for cause: Provider in breach of applicable law, regulations or contractual provisions `eba_CO:x6` - Termination for cause: Identified impediments of the provider capable of altering the supported function `eba_CO:x7` - Termination for cause: Provider's weaknesses regarding the management and security of sensitive data or information `eba_CO:x8` - Termination: As requested by the competent authority `eba_CO:x9` - Other reasons for termination
is_intragroup	boolean Whether this is an intragroup contract
dora_exclude	boolean (Exclude from DORA) Exclude this contract from DORA RoI reporting
	GoverningLawCountryEnum (string) or BlankEnum (any) Country whose law governs this contract `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
notice_period_entity	integer or null <int64> (Notice period for entity (days)) [ -9223372036854776000 .. 9223372036854776000 ] Notice period in days for the financial entity
notice_period_provider	integer or null <int64> (Notice period for provider (days)) [ -9223372036854776000 .. 9223372036854776000 ] Notice period in days for the ICT third-party service provider
folder	string <uuid>
provider_entity	string or null <uuid> Entity providing this contract
beneficiary_entity	string or null <uuid> Entity benefiting from/receiving this contract
overarching_contract	string or null <uuid> Parent/overarching contract if this is a subordinate arrangement
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]
owner	Array of strings <uuid> [ items <uuid > ]
evidences	Array of strings <uuid> [ items <uuid > ] Supporting evidence for this contract
solutions	Array of strings <uuid> [ items <uuid > ] Solutions covered by this contract

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"status": "draft",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"ref_id": "string",
"dora_contractual_arrangement": "eba_CO:x1",
"currency": "AED",
"annual_expense": 0.1,
"termination_reason": "eba_CO:x4",
"is_intragroup": true,
"dora_exclude": true,
"governing_law_country": "AF",
"notice_period_entity": -9223372036854776000,
"notice_period_provider": -9223372036854776000,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"beneficiary_entity": "bff50a6d-bbda-4436-8381-7e09feff0bf4",
"overarching_contract": "3eb9b23f-502b-4d69-93fe-d54b4a33a902",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"evidences": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"status": "draft",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"ref_id": "string",
"dora_contractual_arrangement": "eba_CO:x1",
"currency": "AED",
"annual_expense": 0.1,
"termination_reason": "eba_CO:x4",
"is_intragroup": true,
"dora_exclude": true,
"governing_law_country": "AF",
"notice_period_entity": -9223372036854776000,
"notice_period_provider": -9223372036854776000,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"beneficiary_entity": "bff50a6d-bbda-4436-8381-7e09feff0bf4",
"overarching_contract": "3eb9b23f-502b-4d69-93fe-d54b4a33a902",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"evidences": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

contracts_destroy

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Contract.

Responses

contracts_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Contract.

Responses

contracts_object_retrieve

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Contract.

Responses

contracts_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:

knoxApiToken

Responses

contracts_currency_retrieve

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

Responses

contracts_dora_contractual_arrangement_retrieve

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

Responses

contracts_governing_law_country_retrieve

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

Responses

contracts_status_retrieve

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

Responses

contracts_termination_reason_retrieve

API endpoint that allows contracts to be viewed or edited.

Authorizations:

knoxApiToken

Responses

entity-assessments

entity_assessments_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

authors	Array of strings <uuid> [ items <uuid > ]
conclusion	Array of strings or null Items Enum: "blocker" "not_applicable" "ok" "warning" `blocker` - Blocker `warning` - Warning `ok` - Ok `not_applicable` - Not applicable
criticality	integer
entity	Array of strings <uuid> [ items <uuid > ]
folder	Array of strings <uuid> [ items <uuid > ]
genericcollection	Array of strings <uuid> [ items <uuid > ]
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
limit	integer Number of results to return per page.
name	string
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
perimeter	Array of strings <uuid> [ items <uuid > ]
perimeter__folder	Array of strings <uuid> [ items <uuid > ]
search	string A search term.
status	Array of strings or null Items Enum: "deprecated" "done" "in_progress" "in_review" "planned" `planned` - Planned `in_progress` - In progress `in_review` - In review `done` - Done `deprecated` - Deprecated

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"compliance_assessment": "string",
"evidence": "string",
"perimeter": "string",
"entity": "string",
"folder": "string",
"solutions": ["string"
],
"representatives": ["string"
],
"authors": ["string"
],
"reviewers": ["string"
],
"validation_flows": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"eta": "2019-08-24",
"due_date": "2019-08-24",
"version": "string",
"status": "planned",
"observation": "string",
"is_locked": true,
"criticality": -9223372036854776000,
"conclusion": "blocker"
}
]
}

entity_assessments_create

API endpoint that allows entity assessments to be viewed or edited.

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

create_audit	boolean Default: false
framework	string <uuid>
selected_implementation_groups	Array of strings
is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
eta	string or null <date>
due_date	string or null <date>
version	string or null <= 100 characters Version of the compliance assessment (eg. 1.0, 2.0, etc.)
	(Status6d9Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
observation	string or null
is_locked	boolean or null
criticality	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
penetration	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
dependency	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
maturity	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
trust	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
	(ConclusionEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
folder	string <uuid>
perimeter	string or null <uuid>
entity required	string <uuid>
compliance_assessment	string or null <uuid>
evidence	string or null <uuid>
reviewers	Array of strings <uuid> [ items <uuid > ]
authors	Array of strings <uuid> [ items <uuid > ]
representatives	Array of strings <uuid> (Representative) [ items <uuid > ]
solutions	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"create_audit": false,
"framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
"selected_implementation_groups": ["string"
],
"is_published": true,
"name": "string",
"description": "string",
"eta": "2019-08-24",
"due_date": "2019-08-24",
"version": "string",
"status": "planned",
"observation": "string",
"is_locked": true,
"criticality": -9223372036854776000,
"penetration": -9223372036854776000,
"dependency": -9223372036854776000,
"maturity": -9223372036854776000,
"trust": -9223372036854776000,
"conclusion": "blocker",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
"evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
"reviewers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"authors": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"representatives": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"create_audit": false,
"framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
"selected_implementation_groups": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"eta": "2019-08-24",
"due_date": "2019-08-24",
"version": "string",
"status": "planned",
"observation": "string",
"is_locked": true,
"criticality": -9223372036854776000,
"penetration": -9223372036854776000,
"dependency": -9223372036854776000,
"maturity": -9223372036854776000,
"trust": -9223372036854776000,
"conclusion": "blocker",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
"evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
"reviewers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"authors": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"representatives": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

entity_assessments_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity assessment.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"compliance_assessment": "string",
"evidence": "string",
"perimeter": "string",
"entity": "string",
"folder": "string",
"solutions": ["string"
],
"representatives": ["string"
],
"authors": ["string"
],
"reviewers": ["string"
],
"validation_flows": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"eta": "2019-08-24",
"due_date": "2019-08-24",
"version": "string",
"status": "planned",
"observation": "string",
"is_locked": true,
"criticality": -9223372036854776000,
"conclusion": "blocker"
}

entity_assessments_update

API endpoint that allows entity assessments to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity assessment.

Request Body schema:
application/json
required

create_audit	boolean Default: false
framework	string <uuid>
selected_implementation_groups	Array of strings
is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
eta	string or null <date>
due_date	string or null <date>
version	string or null <= 100 characters Version of the compliance assessment (eg. 1.0, 2.0, etc.)
	(Status6d9Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
observation	string or null
is_locked	boolean or null
criticality	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
penetration	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
dependency	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
maturity	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
trust	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
	(ConclusionEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
folder	string <uuid>
perimeter	string or null <uuid>
entity required	string <uuid>
compliance_assessment	string or null <uuid>
evidence	string or null <uuid>
reviewers	Array of strings <uuid> [ items <uuid > ]
authors	Array of strings <uuid> [ items <uuid > ]
representatives	Array of strings <uuid> (Representative) [ items <uuid > ]
solutions	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"create_audit": false,
"framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
"selected_implementation_groups": ["string"
],
"is_published": true,
"name": "string",
"description": "string",
"eta": "2019-08-24",
"due_date": "2019-08-24",
"version": "string",
"status": "planned",
"observation": "string",
"is_locked": true,
"criticality": -9223372036854776000,
"penetration": -9223372036854776000,
"dependency": -9223372036854776000,
"maturity": -9223372036854776000,
"trust": -9223372036854776000,
"conclusion": "blocker",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
"evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
"reviewers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"authors": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"representatives": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"create_audit": false,
"framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
"selected_implementation_groups": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"eta": "2019-08-24",
"due_date": "2019-08-24",
"version": "string",
"status": "planned",
"observation": "string",
"is_locked": true,
"criticality": -9223372036854776000,
"penetration": -9223372036854776000,
"dependency": -9223372036854776000,
"maturity": -9223372036854776000,
"trust": -9223372036854776000,
"conclusion": "blocker",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
"evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
"reviewers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"authors": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"representatives": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

entity_assessments_partial_update

API endpoint that allows entity assessments to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity assessment.

Request Body schema:
application/json

create_audit	boolean Default: false
framework	string <uuid>
selected_implementation_groups	Array of strings
is_published	boolean (Published)
name	string <= 200 characters
description	string or null
eta	string or null <date>
due_date	string or null <date>
version	string or null <= 100 characters Version of the compliance assessment (eg. 1.0, 2.0, etc.)
	(Status6d9Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
observation	string or null
is_locked	boolean or null
criticality	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
penetration	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
dependency	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
maturity	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
trust	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
	(ConclusionEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
folder	string <uuid>
perimeter	string or null <uuid>
entity	string <uuid>
compliance_assessment	string or null <uuid>
evidence	string or null <uuid>
reviewers	Array of strings <uuid> [ items <uuid > ]
authors	Array of strings <uuid> [ items <uuid > ]
representatives	Array of strings <uuid> (Representative) [ items <uuid > ]
solutions	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"create_audit": false,
"framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
"selected_implementation_groups": ["string"
],
"is_published": true,
"name": "string",
"description": "string",
"eta": "2019-08-24",
"due_date": "2019-08-24",
"version": "string",
"status": "planned",
"observation": "string",
"is_locked": true,
"criticality": -9223372036854776000,
"penetration": -9223372036854776000,
"dependency": -9223372036854776000,
"maturity": -9223372036854776000,
"trust": -9223372036854776000,
"conclusion": "blocker",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
"evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
"reviewers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"authors": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"representatives": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"create_audit": false,
"framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
"selected_implementation_groups": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"eta": "2019-08-24",
"due_date": "2019-08-24",
"version": "string",
"status": "planned",
"observation": "string",
"is_locked": true,
"criticality": -9223372036854776000,
"penetration": -9223372036854776000,
"dependency": -9223372036854776000,
"maturity": -9223372036854776000,
"trust": -9223372036854776000,
"conclusion": "blocker",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
"evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
"reviewers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"authors": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"representatives": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"solutions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

entity_assessments_destroy

API endpoint that allows entity assessments to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity assessment.

Responses

entity_assessments_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity assessment.

Responses

entity_assessments_object_retrieve

API endpoint that allows entity assessments to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity assessment.

Responses

entity_assessments_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:

knoxApiToken

Responses

entity_assessments_conclusion_retrieve

API endpoint that allows entity assessments to be viewed or edited.

Authorizations:

knoxApiToken

Responses

entity_assessments_metrics_retrieve

API endpoint that allows entity assessments to be viewed or edited.

Authorizations:

knoxApiToken

Responses

entity_assessments_status_retrieve

API endpoint that allows entity assessments to be viewed or edited.

Authorizations:

knoxApiToken

Responses

representatives

representatives_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

entity	Array of strings <uuid> [ items <uuid > ]
filtering_labels	Array of strings <uuid> [ items <uuid > ]
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
ref_id	string
search	string A search term.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"entity": "string",
"user": "string",
"filtering_labels": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"ref_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string",
"role": "string",
"description": "string"
}
]
}

representatives_create

API endpoint that allows representatives to be viewed or edited.

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

create_user	boolean Default: false
is_published	boolean (Published)
ref_id	string <= 255 characters
email required	string <email> <= 254 characters
first_name	string <= 255 characters
last_name	string <= 255 characters
phone	string <= 255 characters
role	string <= 255 characters
description	string
entity required	string <uuid>
user	string or null <uuid>
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"create_user": false,
"is_published": true,
"ref_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string",
"role": "string",
"description": "string",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"user": "76f62a58-5404-486d-9afc-07bded328704",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"create_user": false,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"ref_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string",
"role": "string",
"description": "string",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"user": "76f62a58-5404-486d-9afc-07bded328704",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

representatives_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this representative.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"entity": "string",
"user": "string",
"filtering_labels": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"ref_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string",
"role": "string",
"description": "string"
}

representatives_update

API endpoint that allows representatives to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this representative.

Request Body schema:
application/json
required

create_user	boolean Default: false
is_published	boolean (Published)
ref_id	string <= 255 characters
email required	string <email> <= 254 characters
first_name	string <= 255 characters
last_name	string <= 255 characters
phone	string <= 255 characters
role	string <= 255 characters
description	string
entity required	string <uuid>
user	string or null <uuid>
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"create_user": false,
"is_published": true,
"ref_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string",
"role": "string",
"description": "string",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"user": "76f62a58-5404-486d-9afc-07bded328704",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"create_user": false,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"ref_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string",
"role": "string",
"description": "string",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"user": "76f62a58-5404-486d-9afc-07bded328704",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

representatives_partial_update

API endpoint that allows representatives to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this representative.

Request Body schema:
application/json

create_user	boolean Default: false
is_published	boolean (Published)
ref_id	string <= 255 characters
email	string <email> <= 254 characters
first_name	string <= 255 characters
last_name	string <= 255 characters
phone	string <= 255 characters
role	string <= 255 characters
description	string
entity	string <uuid>
user	string or null <uuid>
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"create_user": false,
"is_published": true,
"ref_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string",
"role": "string",
"description": "string",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"user": "76f62a58-5404-486d-9afc-07bded328704",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"create_user": false,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"ref_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string",
"role": "string",
"description": "string",
"entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
"user": "76f62a58-5404-486d-9afc-07bded328704",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

representatives_destroy

API endpoint that allows representatives to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this representative.

Responses

representatives_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this representative.

Responses

representatives_object_retrieve

API endpoint that allows representatives to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this representative.

Responses

representatives_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:

knoxApiToken

Responses

solutions

solutions_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

assets	Array of strings <uuid> [ items <uuid > ]
contracts	Array of strings <uuid> [ items <uuid > ]
criticality	integer
data_location_processing	Array of strings (Location of data processing) Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW" "x28" Country where data is processed/managed `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
data_location_storage	Array of strings (Location of data at rest) Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW" "x28" Country where data is stored `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
dora_alternative_providers_identified	Array of strings (Alternative providers identified) Items Enum: "eba_BT:x21" "eba_BT:x28" "eba_BT:x29" Are there alternative ICT third-party service providers identified? `eba_BT:x28` - Yes `eba_BT:x29` - No `eba_BT:x21` - Assessment not performed
dora_data_sensitiveness	Array of strings (Data sensitiveness) Items Enum: "eba_ZZ:x791" "eba_ZZ:x792" "eba_ZZ:x793" Sensitiveness of the data stored `eba_ZZ:x791` - Low `eba_ZZ:x792` - Medium `eba_ZZ:x793` - High
dora_discontinuing_impact	Array of strings (Discontinuing impact) Items Enum: "eba_ZZ:x791" "eba_ZZ:x792" "eba_ZZ:x793" "eba_ZZ:x799" Impact of discontinuing the ICT services `eba_ZZ:x791` - Low `eba_ZZ:x792` - Medium `eba_ZZ:x793` - High `eba_ZZ:x799` - Assessment not performed
dora_has_exit_plan	Array of strings (Exit plan) Items Enum: "eba_BT:x28" "eba_BT:x29" Existence of an exit plan `eba_BT:x28` - Yes `eba_BT:x29` - No
dora_ict_service_type	Array of strings Items Enum: "eba_TA:S01" "eba_TA:S02" "eba_TA:S03" "eba_TA:S04" "eba_TA:S05" "eba_TA:S06" "eba_TA:S07" "eba_TA:S08" "eba_TA:S09" "eba_TA:S10" "eba_TA:S11" "eba_TA:S12" "eba_TA:S13" "eba_TA:S14" "eba_TA:S15" "eba_TA:S16" "eba_TA:S17" "eba_TA:S18" "eba_TA:S19" DORA ICT service type classification `eba_TA:S01` - ICT project management `eba_TA:S02` - ICT Development `eba_TA:S03` - ICT help desk and first level support `eba_TA:S04` - ICT security management services `eba_TA:S05` - Provision of data `eba_TA:S06` - Data analysis `eba_TA:S07` - ICT, facilities and hosting services (excluding Cloud services) `eba_TA:S08` - Computation `eba_TA:S09` - Non-Cloud Data storage `eba_TA:S10` - Telecom carrier `eba_TA:S11` - Network infrastructure `eba_TA:S12` - Hardware and physical devices `eba_TA:S13` - Software licencing (excluding SaaS) `eba_TA:S14` - ICT operation management (including maintenance) `eba_TA:S15` - ICT Consulting `eba_TA:S16` - ICT Risk management `eba_TA:S17` - Cloud services: IaaS `eba_TA:S18` - Cloud services: PaaS `eba_TA:S19` - Cloud services: SaaS
dora_non_substitutability_reason	Array of strings (Non-substitutability reason) Items Enum: "eba_ZZ:x963" "eba_ZZ:x964" "eba_ZZ:x965" Reason if the ICT third-party service provider is considered not substitutable or difficult to be substitutable `eba_ZZ:x963` - Lack of real alternatives `eba_ZZ:x964` - Difficulties in migrating or reintegrating `eba_ZZ:x965` - Lack of real alternatives and difficulties in migrating or reintegrating
dora_reintegration_possibility	Array of strings (Reintegration possibility) Items Enum: "eba_ZZ:x0" "eba_ZZ:x798" "eba_ZZ:x966" "eba_ZZ:x967" Possibility of reintegration of the contracted ICT service `eba_ZZ:x798` - Easy `eba_ZZ:x966` - Difficult `eba_ZZ:x967` - Highly complex `eba_ZZ:x0` - Not applicable
dora_reliance_level	Array of strings (Level of reliance) Items Enum: "eba_ZZ:x794" "eba_ZZ:x795" "eba_ZZ:x796" "eba_ZZ:x797" Level of reliance on the ICT service `eba_ZZ:x794` - Not significant `eba_ZZ:x795` - Low reliance `eba_ZZ:x796` - Material reliance `eba_ZZ:x797` - Full reliance
dora_substitutability	Array of strings (Substitutability) Items Enum: "eba_ZZ:x959" "eba_ZZ:x960" "eba_ZZ:x961" "eba_ZZ:x962" Substitutability of the ICT third-party service provider `eba_ZZ:x959` - Not substitutable `eba_ZZ:x962` - Easily substitutable `eba_ZZ:x961` - Medium complexity in terms of substitutability `eba_ZZ:x960` - Highly complex substitutability
filtering_labels	Array of strings <uuid> [ items <uuid > ]
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
is_active	boolean
limit	integer Number of results to return per page.
name	string
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
owner	Array of strings <uuid> [ items <uuid > ]
provider_entity	Array of strings <uuid> [ items <uuid > ]
ref_id	string
search	string A search term.
storage_of_data	boolean

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"provider_entity": "string",
"recipient_entity": "string",
"assets": ["string"
],
"contracts": ["string"
],
"owner": ["string"
],
"filtering_labels": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"reference_link": "http://example.com",
"criticality": -9223372036854776000,
"dora_ict_service_type": "eba_TA:S01",
"storage_of_data": true,
"data_location_storage": "AF",
"data_location_processing": "AF",
"dora_data_sensitiveness": "eba_ZZ:x791",
"dora_reliance_level": "eba_ZZ:x794",
"dora_substitutability": "eba_ZZ:x959",
"dora_non_substitutability_reason": "eba_ZZ:x963",
"dora_has_exit_plan": "eba_BT:x28",
"dora_reintegration_possibility": "eba_ZZ:x798",
"dora_discontinuing_impact": "eba_ZZ:x791",
"dora_alternative_providers_identified": "eba_BT:x28",
"dora_alternative_providers": "string"
}
]
}

solutions_create

API endpoint that allows solutions to be viewed or edited.

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
ref_id	string <= 255 characters
is_active	boolean
reference_link	string or null <uri> <= 2048 characters
criticality	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
	DoraIctServiceTypeEnum (string) or BlankEnum (any) DORA ICT service type classification `eba_TA:S01` - ICT project management `eba_TA:S02` - ICT Development `eba_TA:S03` - ICT help desk and first level support `eba_TA:S04` - ICT security management services `eba_TA:S05` - Provision of data `eba_TA:S06` - Data analysis `eba_TA:S07` - ICT, facilities and hosting services (excluding Cloud services) `eba_TA:S08` - Computation `eba_TA:S09` - Non-Cloud Data storage `eba_TA:S10` - Telecom carrier `eba_TA:S11` - Network infrastructure `eba_TA:S12` - Hardware and physical devices `eba_TA:S13` - Software licencing (excluding SaaS) `eba_TA:S14` - ICT operation management (including maintenance) `eba_TA:S15` - ICT Consulting `eba_TA:S16` - ICT Risk management `eba_TA:S17` - Cloud services: IaaS `eba_TA:S18` - Cloud services: PaaS `eba_TA:S19` - Cloud services: SaaS
storage_of_data	boolean Whether data is stored by the ICT service provider
	DataLocationStorageEnum (string) or BlankEnum (any) (Location of data at rest) Country where data is stored `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
	DataLocationProcessingEnum (string) or BlankEnum (any) (Location of data processing) Country where data is processed/managed `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
	DoraDataSensitivenessEnum (string) or BlankEnum (any) (Data sensitiveness) Sensitiveness of the data stored `eba_ZZ:x791` - Low `eba_ZZ:x792` - Medium `eba_ZZ:x793` - High
	DoraRelianceLevelEnum (string) or BlankEnum (any) (Level of reliance) Level of reliance on the ICT service `eba_ZZ:x794` - Not significant `eba_ZZ:x795` - Low reliance `eba_ZZ:x796` - Material reliance `eba_ZZ:x797` - Full reliance
	DoraSubstitutabilityEnum (string) or BlankEnum (any) (Substitutability) Substitutability of the ICT third-party service provider `eba_ZZ:x959` - Not substitutable `eba_ZZ:x962` - Easily substitutable `eba_ZZ:x961` - Medium complexity in terms of substitutability `eba_ZZ:x960` - Highly complex substitutability
	DoraNonSubstitutabilityReasonEnum (string) or BlankEnum (any) (Non-substitutability reason) Reason if the ICT third-party service provider is considered not substitutable or difficult to be substitutable `eba_ZZ:x963` - Lack of real alternatives `eba_ZZ:x964` - Difficulties in migrating or reintegrating `eba_ZZ:x965` - Lack of real alternatives and difficulties in migrating or reintegrating
	DoraHasExitPlanEnum (string) or BlankEnum (any) (Exit plan) Existence of an exit plan `eba_BT:x28` - Yes `eba_BT:x29` - No
	DoraReintegrationPossibilityEnum (string) or BlankEnum (any) (Reintegration possibility) Possibility of reintegration of the contracted ICT service `eba_ZZ:x798` - Easy `eba_ZZ:x966` - Difficult `eba_ZZ:x967` - Highly complex `eba_ZZ:x0` - Not applicable
	DoraDiscontinuingImpactEnum (string) or BlankEnum (any) (Discontinuing impact) Impact of discontinuing the ICT services `eba_ZZ:x791` - Low `eba_ZZ:x792` - Medium `eba_ZZ:x793` - High `eba_ZZ:x799` - Assessment not performed
	DoraAlternativeProvidersIdentifiedEnum (string) or BlankEnum (any) (Alternative providers identified) Are there alternative ICT third-party service providers identified? `eba_BT:x28` - Yes `eba_BT:x29` - No `eba_BT:x21` - Assessment not performed
dora_alternative_providers	string (Alternative providers) Identification of alternative ICT third-party service providers
provider_entity required	string <uuid>
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]
owner	Array of strings <uuid> [ items <uuid > ]
assets	Array of strings <uuid> (Related assets) [ items <uuid > ] Assets related to the solution

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"reference_link": "http://example.com",
"criticality": -9223372036854776000,
"dora_ict_service_type": "eba_TA:S01",
"storage_of_data": true,
"data_location_storage": "AF",
"data_location_processing": "AF",
"dora_data_sensitiveness": "eba_ZZ:x791",
"dora_reliance_level": "eba_ZZ:x794",
"dora_substitutability": "eba_ZZ:x959",
"dora_non_substitutability_reason": "eba_ZZ:x963",
"dora_has_exit_plan": "eba_BT:x28",
"dora_reintegration_possibility": "eba_ZZ:x798",
"dora_discontinuing_impact": "eba_ZZ:x791",
"dora_alternative_providers_identified": "eba_BT:x28",
"dora_alternative_providers": "string",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"assets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"reference_link": "http://example.com",
"criticality": -9223372036854776000,
"dora_ict_service_type": "eba_TA:S01",
"storage_of_data": true,
"data_location_storage": "AF",
"data_location_processing": "AF",
"dora_data_sensitiveness": "eba_ZZ:x791",
"dora_reliance_level": "eba_ZZ:x794",
"dora_substitutability": "eba_ZZ:x959",
"dora_non_substitutability_reason": "eba_ZZ:x963",
"dora_has_exit_plan": "eba_BT:x28",
"dora_reintegration_possibility": "eba_ZZ:x798",
"dora_discontinuing_impact": "eba_ZZ:x791",
"dora_alternative_providers_identified": "eba_BT:x28",
"dora_alternative_providers": "string",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"assets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

solutions_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Solution.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"provider_entity": "string",
"recipient_entity": "string",
"assets": ["string"
],
"contracts": ["string"
],
"owner": ["string"
],
"filtering_labels": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"reference_link": "http://example.com",
"criticality": -9223372036854776000,
"dora_ict_service_type": "eba_TA:S01",
"storage_of_data": true,
"data_location_storage": "AF",
"data_location_processing": "AF",
"dora_data_sensitiveness": "eba_ZZ:x791",
"dora_reliance_level": "eba_ZZ:x794",
"dora_substitutability": "eba_ZZ:x959",
"dora_non_substitutability_reason": "eba_ZZ:x963",
"dora_has_exit_plan": "eba_BT:x28",
"dora_reintegration_possibility": "eba_ZZ:x798",
"dora_discontinuing_impact": "eba_ZZ:x791",
"dora_alternative_providers_identified": "eba_BT:x28",
"dora_alternative_providers": "string"
}

solutions_update

API endpoint that allows solutions to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Solution.

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
ref_id	string <= 255 characters
is_active	boolean
reference_link	string or null <uri> <= 2048 characters
criticality	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
	DoraIctServiceTypeEnum (string) or BlankEnum (any) DORA ICT service type classification `eba_TA:S01` - ICT project management `eba_TA:S02` - ICT Development `eba_TA:S03` - ICT help desk and first level support `eba_TA:S04` - ICT security management services `eba_TA:S05` - Provision of data `eba_TA:S06` - Data analysis `eba_TA:S07` - ICT, facilities and hosting services (excluding Cloud services) `eba_TA:S08` - Computation `eba_TA:S09` - Non-Cloud Data storage `eba_TA:S10` - Telecom carrier `eba_TA:S11` - Network infrastructure `eba_TA:S12` - Hardware and physical devices `eba_TA:S13` - Software licencing (excluding SaaS) `eba_TA:S14` - ICT operation management (including maintenance) `eba_TA:S15` - ICT Consulting `eba_TA:S16` - ICT Risk management `eba_TA:S17` - Cloud services: IaaS `eba_TA:S18` - Cloud services: PaaS `eba_TA:S19` - Cloud services: SaaS
storage_of_data	boolean Whether data is stored by the ICT service provider
	DataLocationStorageEnum (string) or BlankEnum (any) (Location of data at rest) Country where data is stored `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
	DataLocationProcessingEnum (string) or BlankEnum (any) (Location of data processing) Country where data is processed/managed `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
	DoraDataSensitivenessEnum (string) or BlankEnum (any) (Data sensitiveness) Sensitiveness of the data stored `eba_ZZ:x791` - Low `eba_ZZ:x792` - Medium `eba_ZZ:x793` - High
	DoraRelianceLevelEnum (string) or BlankEnum (any) (Level of reliance) Level of reliance on the ICT service `eba_ZZ:x794` - Not significant `eba_ZZ:x795` - Low reliance `eba_ZZ:x796` - Material reliance `eba_ZZ:x797` - Full reliance
	DoraSubstitutabilityEnum (string) or BlankEnum (any) (Substitutability) Substitutability of the ICT third-party service provider `eba_ZZ:x959` - Not substitutable `eba_ZZ:x962` - Easily substitutable `eba_ZZ:x961` - Medium complexity in terms of substitutability `eba_ZZ:x960` - Highly complex substitutability
	DoraNonSubstitutabilityReasonEnum (string) or BlankEnum (any) (Non-substitutability reason) Reason if the ICT third-party service provider is considered not substitutable or difficult to be substitutable `eba_ZZ:x963` - Lack of real alternatives `eba_ZZ:x964` - Difficulties in migrating or reintegrating `eba_ZZ:x965` - Lack of real alternatives and difficulties in migrating or reintegrating
	DoraHasExitPlanEnum (string) or BlankEnum (any) (Exit plan) Existence of an exit plan `eba_BT:x28` - Yes `eba_BT:x29` - No
	DoraReintegrationPossibilityEnum (string) or BlankEnum (any) (Reintegration possibility) Possibility of reintegration of the contracted ICT service `eba_ZZ:x798` - Easy `eba_ZZ:x966` - Difficult `eba_ZZ:x967` - Highly complex `eba_ZZ:x0` - Not applicable
	DoraDiscontinuingImpactEnum (string) or BlankEnum (any) (Discontinuing impact) Impact of discontinuing the ICT services `eba_ZZ:x791` - Low `eba_ZZ:x792` - Medium `eba_ZZ:x793` - High `eba_ZZ:x799` - Assessment not performed
	DoraAlternativeProvidersIdentifiedEnum (string) or BlankEnum (any) (Alternative providers identified) Are there alternative ICT third-party service providers identified? `eba_BT:x28` - Yes `eba_BT:x29` - No `eba_BT:x21` - Assessment not performed
dora_alternative_providers	string (Alternative providers) Identification of alternative ICT third-party service providers
provider_entity required	string <uuid>
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]
owner	Array of strings <uuid> [ items <uuid > ]
assets	Array of strings <uuid> (Related assets) [ items <uuid > ] Assets related to the solution

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"reference_link": "http://example.com",
"criticality": -9223372036854776000,
"dora_ict_service_type": "eba_TA:S01",
"storage_of_data": true,
"data_location_storage": "AF",
"data_location_processing": "AF",
"dora_data_sensitiveness": "eba_ZZ:x791",
"dora_reliance_level": "eba_ZZ:x794",
"dora_substitutability": "eba_ZZ:x959",
"dora_non_substitutability_reason": "eba_ZZ:x963",
"dora_has_exit_plan": "eba_BT:x28",
"dora_reintegration_possibility": "eba_ZZ:x798",
"dora_discontinuing_impact": "eba_ZZ:x791",
"dora_alternative_providers_identified": "eba_BT:x28",
"dora_alternative_providers": "string",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"assets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"reference_link": "http://example.com",
"criticality": -9223372036854776000,
"dora_ict_service_type": "eba_TA:S01",
"storage_of_data": true,
"data_location_storage": "AF",
"data_location_processing": "AF",
"dora_data_sensitiveness": "eba_ZZ:x791",
"dora_reliance_level": "eba_ZZ:x794",
"dora_substitutability": "eba_ZZ:x959",
"dora_non_substitutability_reason": "eba_ZZ:x963",
"dora_has_exit_plan": "eba_BT:x28",
"dora_reintegration_possibility": "eba_ZZ:x798",
"dora_discontinuing_impact": "eba_ZZ:x791",
"dora_alternative_providers_identified": "eba_BT:x28",
"dora_alternative_providers": "string",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"assets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

solutions_partial_update

API endpoint that allows solutions to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Solution.

Request Body schema:
application/json

is_published	boolean (Published)
name	string <= 200 characters
description	string or null
ref_id	string <= 255 characters
is_active	boolean
reference_link	string or null <uri> <= 2048 characters
criticality	integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
	DoraIctServiceTypeEnum (string) or BlankEnum (any) DORA ICT service type classification `eba_TA:S01` - ICT project management `eba_TA:S02` - ICT Development `eba_TA:S03` - ICT help desk and first level support `eba_TA:S04` - ICT security management services `eba_TA:S05` - Provision of data `eba_TA:S06` - Data analysis `eba_TA:S07` - ICT, facilities and hosting services (excluding Cloud services) `eba_TA:S08` - Computation `eba_TA:S09` - Non-Cloud Data storage `eba_TA:S10` - Telecom carrier `eba_TA:S11` - Network infrastructure `eba_TA:S12` - Hardware and physical devices `eba_TA:S13` - Software licencing (excluding SaaS) `eba_TA:S14` - ICT operation management (including maintenance) `eba_TA:S15` - ICT Consulting `eba_TA:S16` - ICT Risk management `eba_TA:S17` - Cloud services: IaaS `eba_TA:S18` - Cloud services: PaaS `eba_TA:S19` - Cloud services: SaaS
storage_of_data	boolean Whether data is stored by the ICT service provider
	DataLocationStorageEnum (string) or BlankEnum (any) (Location of data at rest) Country where data is stored `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
	DataLocationProcessingEnum (string) or BlankEnum (any) (Location of data processing) Country where data is processed/managed `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
	DoraDataSensitivenessEnum (string) or BlankEnum (any) (Data sensitiveness) Sensitiveness of the data stored `eba_ZZ:x791` - Low `eba_ZZ:x792` - Medium `eba_ZZ:x793` - High
	DoraRelianceLevelEnum (string) or BlankEnum (any) (Level of reliance) Level of reliance on the ICT service `eba_ZZ:x794` - Not significant `eba_ZZ:x795` - Low reliance `eba_ZZ:x796` - Material reliance `eba_ZZ:x797` - Full reliance
	DoraSubstitutabilityEnum (string) or BlankEnum (any) (Substitutability) Substitutability of the ICT third-party service provider `eba_ZZ:x959` - Not substitutable `eba_ZZ:x962` - Easily substitutable `eba_ZZ:x961` - Medium complexity in terms of substitutability `eba_ZZ:x960` - Highly complex substitutability
	DoraNonSubstitutabilityReasonEnum (string) or BlankEnum (any) (Non-substitutability reason) Reason if the ICT third-party service provider is considered not substitutable or difficult to be substitutable `eba_ZZ:x963` - Lack of real alternatives `eba_ZZ:x964` - Difficulties in migrating or reintegrating `eba_ZZ:x965` - Lack of real alternatives and difficulties in migrating or reintegrating
	DoraHasExitPlanEnum (string) or BlankEnum (any) (Exit plan) Existence of an exit plan `eba_BT:x28` - Yes `eba_BT:x29` - No
	DoraReintegrationPossibilityEnum (string) or BlankEnum (any) (Reintegration possibility) Possibility of reintegration of the contracted ICT service `eba_ZZ:x798` - Easy `eba_ZZ:x966` - Difficult `eba_ZZ:x967` - Highly complex `eba_ZZ:x0` - Not applicable
	DoraDiscontinuingImpactEnum (string) or BlankEnum (any) (Discontinuing impact) Impact of discontinuing the ICT services `eba_ZZ:x791` - Low `eba_ZZ:x792` - Medium `eba_ZZ:x793` - High `eba_ZZ:x799` - Assessment not performed
	DoraAlternativeProvidersIdentifiedEnum (string) or BlankEnum (any) (Alternative providers identified) Are there alternative ICT third-party service providers identified? `eba_BT:x28` - Yes `eba_BT:x29` - No `eba_BT:x21` - Assessment not performed
dora_alternative_providers	string (Alternative providers) Identification of alternative ICT third-party service providers
provider_entity	string <uuid>
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]
owner	Array of strings <uuid> [ items <uuid > ]
assets	Array of strings <uuid> (Related assets) [ items <uuid > ] Assets related to the solution

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"reference_link": "http://example.com",
"criticality": -9223372036854776000,
"dora_ict_service_type": "eba_TA:S01",
"storage_of_data": true,
"data_location_storage": "AF",
"data_location_processing": "AF",
"dora_data_sensitiveness": "eba_ZZ:x791",
"dora_reliance_level": "eba_ZZ:x794",
"dora_substitutability": "eba_ZZ:x959",
"dora_non_substitutability_reason": "eba_ZZ:x963",
"dora_has_exit_plan": "eba_BT:x28",
"dora_reintegration_possibility": "eba_ZZ:x798",
"dora_discontinuing_impact": "eba_ZZ:x791",
"dora_alternative_providers_identified": "eba_BT:x28",
"dora_alternative_providers": "string",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"assets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"reference_link": "http://example.com",
"criticality": -9223372036854776000,
"dora_ict_service_type": "eba_TA:S01",
"storage_of_data": true,
"data_location_storage": "AF",
"data_location_processing": "AF",
"dora_data_sensitiveness": "eba_ZZ:x791",
"dora_reliance_level": "eba_ZZ:x794",
"dora_substitutability": "eba_ZZ:x959",
"dora_non_substitutability_reason": "eba_ZZ:x963",
"dora_has_exit_plan": "eba_BT:x28",
"dora_reintegration_possibility": "eba_ZZ:x798",
"dora_discontinuing_impact": "eba_ZZ:x791",
"dora_alternative_providers_identified": "eba_BT:x28",
"dora_alternative_providers": "string",
"provider_entity": "8d2f8ea2-892e-4ee5-8486-e8f257bb1138",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"owner": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"assets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

solutions_destroy

API endpoint that allows solutions to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Solution.

Responses

solutions_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Solution.

Responses

solutions_object_retrieve

API endpoint that allows solutions to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Solution.

Responses

solutions_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

CISO Assistant API — Third-Party Risk Management (0.7.0)

contracts

contracts_list

Authorizations:

query Parameters

Responses

Response samples

contracts_create

Authorizations:

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

contracts_retrieve

Authorizations:

path Parameters

Responses

Response samples

contracts_update

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

contracts_partial_update

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

contracts_destroy

Authorizations:

path Parameters

Responses

contracts_cascade_info_retrieve

Authorizations:

path Parameters

Responses

contracts_object_retrieve

Authorizations:

path Parameters

Responses

contracts_batch_action_create

Authorizations:

Responses

contracts_currency_retrieve

Authorizations:

Responses

contracts_dora_contractual_arrangement_retrieve

Authorizations:

Responses

contracts_governing_law_country_retrieve

Authorizations:

Responses

contracts_status_retrieve

Authorizations:

Responses

contracts_termination_reason_retrieve

Authorizations:

Responses

entity-assessments

entity_assessments_list

Authorizations:

query Parameters

Responses

Response samples

entity_assessments_create

Authorizations:

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

entity_assessments_retrieve

Authorizations:

path Parameters

Responses

Response samples

entity_assessments_update

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json