diff --git a/docs/ARC42.md b/docs/ARC42.md
index ed367b2..9495de8 100644
--- a/docs/ARC42.md
+++ b/docs/ARC42.md
@@ -165,10 +165,10 @@ Swagger API info as below:
| Sr. | Request | Response |
|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| 1 | API info: This API will use to start the Auto setup process
HTTP Request details:
Method: POST
Host: [https://example.com](https://example.com)
URI: /autosetup
Request Header:
Authorization: Bearer "``"
Note: Need to get valid auth token from service provider key cloak service using technical user
Request Body:
{
"customer" : {
"organizationName": "string"[required] ,
"organizationUnitName":"string",
"country": "string" [required],
"state": "string",
"city": "string",
"email": "string" [required],
"contactNumber":"string",
"tanNumber": "string",
"registrationNumber":"string",
}
"properties": {
"bpnNumber": "string" [required],
"subscriptionId": "string" [required],
"serviceId": "string" [required],
"role": "string"
}
}
}
E.g.
{
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000003CSGV",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
}
Curl request e.g.
curl \
-X POST \
"https://example.com/autosetup" \
--header "Authorization: Bearer " \
--header "Content-Type: application/json" \
--data-raw '{
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000000XXXX",
"subscriptionId": "string" [required],
"serviceId": "5cf74ef8-e0b7-4984-a872-474828beb5d9"
}
}'\
-s -o /dev/null -w 'Response Code: %{http_code}\n' | String execution Id
E.g.
["string" [required]]()
Note: After getting execution Id you can track status by using #2nd API |
-| 2 | API info: This API will use to check/verify Auto setup process status
HTTP Request details:
Method: GET
Host: https://example.com
URI: /autosetup/
Request Header:
Authorization: Bearer "``"
Note: Need to get valid auth token from service provider key cloak service using technical user
Request Body:
N/A
Curl request e.g.
curl \
-X GET\
"https://example.com/autosetup/" \
--header "Authorization: Bearer " \
-s -o /dev/null -w 'Response Code: %{http_code}\n' | Response Type 1:
If Auto set up process is in process
{
"executionId": "string" [required],
"executionType": "CREATE", /*UPDATE/DELETE*/
"request": {
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000003XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
},
"processResult": [],
"createdTimestamp": "2022-09-06T08:07:45.442755845",
"modifiedTimestamp": "2022-09-06T08:09:20.063916819",
"status": "INPROGRESS"
}
Response Type 2:
If Auto set up process is in success
{
"executionId": "c18c4774-5436-4700-a01d-bffd2db64c10",
"executionType": "CREATE",
"request": {
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000003XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
},
"processResult": [{
"name": "DFT",
"backendUrl": "",
"frontendUrl": ""
}, {
"name": "EDC",
"dataPlaneUrl": "",
"controlPlaneUrl": "",
"apiKeyHeaderName": "string",
"apiKey": "string"
}],
"createdTimestamp": "2022-09-06T08:07:45.442755845",
"modifiedTimestamp": "2022-09-06T08:09:20.063916819",
"status": "SUCCESS"
}
Response Type 3: If Auto set up process is FAILED
{
"executionId": "string" [required],
"executionType": "CREATE",
"request": {
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": { "bpnNumber": "TEST00000003XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
},
"createdTimestamp": "2022-09-06T08:07:45.442755845",
"modifiedTimestamp": "2022-09-06T08:09:20.063916819",
"status": "FAILED"
"remark": "Please connect with technical team for more advice"
}
|
+| 1 | API info: This API will use to start the Auto setup process
HTTP Request details:
Method: POST
Host: [https://example.com](https://example.com)
URI: /autosetup
Request Header:
Authorization: Bearer "``"
Note: Need to get valid auth token from service provider key cloak service using technical user
Request Body:
{
"customer" : {
"organizationName": "string"[required] ,
"organizationUnitName":"string",
"country": "string" [required],
"state": "string",
"city": "string",
"email": "string" [required],
"contactNumber":"string",
"tanNumber": "string",
"registrationNumber":"string",
}
"properties": {
"bpnNumber": "string" [required],
"subscriptionId": "string" [required],
"serviceId": "string" [required],
"role": "string"
}
}
}
E.g.
{
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000003XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
}
Curl request e.g.
curl \
-X POST \
"https://example.com/autosetup" \
--header "Authorization: Bearer " \
--header "Content-Type: application/json" \
--data-raw '{
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000000XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
}'\
-s -o /dev/null -w 'Response Code: %{http_code}\n' | String execution Id
E.g.
["string" [required]]()
Note: After getting execution Id you can track status by using #2nd API |
+| 2 | API info: This API will use to check/verify Auto setup process status
HTTP Request details:
Method: GET
Host: https://example.com
URI: /autosetup/
Request Header:
Authorization: Bearer "``"
Note: Need to get valid auth token from service provider key cloak service using technical user
Request Body:
N/A
Curl request e.g.
curl \
-X GET\
"https://example.com/autosetup/" \
--header "Authorization: Bearer " \
-s -o /dev/null -w 'Response Code: %{http_code}\n' | Response Type 1:
If Auto set up process is in process
{
"executionId": "string" [required],
"executionType": "CREATE", /*UPDATE/DELETE*/
"request": {
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000003XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
},
"processResult": [],
"createdTimestamp": "2022-09-06T08:07:45.442755845",
"modifiedTimestamp": "2022-09-06T08:09:20.063916819",
"status": "INPROGRESS"
}
Response Type 2:
If Auto set up process is in success
{
"executionId": "string" [required],
"executionType": "CREATE",
"request": {
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000003XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
},
"processResult": [{
"name": "DFT",
"backendUrl": "",
"frontendUrl": ""
}, {
"name": "EDC",
"dataPlaneUrl": "",
"controlPlaneUrl": "",
"apiKeyHeaderName": "string",
"apiKey": "string"
}],
"createdTimestamp": "2022-09-06T08:07:45.442755845",
"modifiedTimestamp": "2022-09-06T08:09:20.063916819",
"status": "SUCCESS"
}
Response Type 3: If Auto set up process is FAILED
{
"executionId": "string" [required],
"executionType": "CREATE",
"request": {
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": { "bpnNumber": "TEST00000003XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
},
"createdTimestamp": "2022-09-06T08:07:45.442755845",
"modifiedTimestamp": "2022-09-06T08:09:20.063916819",
"status": "FAILED"
"remark": "Please connect with technical team for more advice"
}
|
| 3 | API info: This API will use to update the existing packages created by the Auto setup process
HTTP Request details:
Method: PUT
Host: https://example.com
URI: /autosetup/
Request Header:
Authorization: Bearer "``"
Note: Need to get valid auth token from service provider key cloak service using technical user
Request Body:
{
"customer" : {
"organizationName": "string"[required] ,
"organizationUnitName":"string",
"country": "string" [required],
"state": "string",
"city": "string",
"email": "string" [required],
"contactNumber":"string",
"tanNumber": "string",
"registrationNumber":"string", }
"properties": {
"bpnNumber": "string" [required],
"subscriptionId": "string" [required],
"serviceId": "string" [required],
"role": "string"
}
}
}
E.g.
{
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000003XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
}
Curl request e.g.
curl \
-X PUT\
"https://example.com/autosetup/" \
--header "Authorization: Bearer " \
--header "Content-Type: application/json" \
--data-raw '{
"customer": {
"organizationName": "Test Company",
"email": "test@email.com",
"country": "de"
},
"properties": {
"bpnNumber": "TEST00000003XXXX",
"subscriptionId": "string" [required],
"serviceId": "string" [required]
}
}'\
-s -o /dev/null -w 'Response Code: %{http_code}\n' | String execution Id
E.g.
"string" [required]
Note: After getting execution Id you can track status by using #2nd API |
-| 4 | API info: This API will use to delete the existing packages created by the Auto setup process
HTTP Request details:
Method: DELETE
Host: https://example.com
URI: /autosetup/
Request Header:
Authorization: Bearer ``
Note: Need to get valid auth token from service provider key cloak service using technical user
Request Body:
N/A
Curl request e.g.
curl \ -X DELETE\ "https://example.com/autosetup/" \ --header "Authorization: Bearer " \ -s -o /dev/null -w 'Response Code: %{http_code}\n' | String execution Id
E.g.
"c18c4774-5436-4700-a01d-bffd2db64c10"
Note: After getting execution Id you can track status by using #2nd API |
+| 4 | API info: This API will use to delete the existing packages created by the Auto setup process
HTTP Request details:
Method: DELETE
Host: https://example.com
URI: /autosetup/
Request Header:
Authorization: Bearer ``
Note: Need to get valid auth token from service provider key cloak service using technical user
Request Body:
N/A
Curl request e.g.
curl \ -X DELETE\ "https://example.com/autosetup/" \ --header "Authorization: Bearer " \ -s -o /dev/null -w 'Response Code: %{http_code}\n' | String execution Id
E.g.
"string" [required]
Note: After getting execution Id you can track status by using #2nd API |
- **Third-PartyAuto Setup process: Defining the API of Dataspace setup process for portal CLOSED**