Skip to content

Commit

Permalink
Connect2All - Synchronous action (microsoft#1942)
Browse files Browse the repository at this point in the history 
* Version 2.4

* Version 1.1

* Changed descriptions and host

* changed version number

* Changed actiontype

Co-authored-by: Arjan Jongmans <a.jongmans@gac.nl>
  • Loading branch information
@GAC-AJO
GAC-AJO and Arjan Jongmans authored Sep 5, 2022
1 parent 431e703 commit 7725bff
Show file tree
Hide file tree
Showing 2 changed files with 271 additions and 3 deletions.
138 changes: 136 additions & 2 deletions certified-connectors/Connect2All On-Premises/apiDefinition.swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@
"basePath": "/",
"consumes": [],
"definitions": {
"Actiontype": {
"description": "The action type of the synchronous action that you wish to execute",
"title": "Action type",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetSynchronousActions",
"parameters": {
"Company": {
"parameter": "Company"
},
"Url": {
"parameter": "Url"
}
}
},
"x-ms-summary": "Action type"
},
"CodeunitId": {
"description": "The codeunit you wish to execute",
"format": "int32",
Expand Down Expand Up @@ -141,6 +158,22 @@
],
"type": "object"
},
"PerformSynchronousActionRequest": {
"properties": {
"actiontype": {
"$ref": "#/definitions/Actiontype"
},
"payload": {
"description": "The payload string to pass to the synchronous action",
"type": "string",
"x-ms-summary": "Payload String"
}
},
"required": [
"actiontype"
],
"type": "object"
},
"ReadRequest": {
"description": "The request to retrieve data",
"properties": {
Expand Down Expand Up @@ -258,7 +291,7 @@
"table": {
"description": "The table from which you want to retrieve data",
"format": "int32",
"title": "Table",
"title": "Table ID",
"type": "integer",
"x-ms-summary": "Table"
}
Expand Down Expand Up @@ -366,7 +399,7 @@
},
"description": "Import and export your Business Central on-premises data",
"title": "Connect2All on-premises",
"version": "1.0"
"version": "1.1"
},
"parameters": {
"Company": {
Expand Down Expand Up @@ -650,6 +683,107 @@
"x-ms-visibility": "important"
}
},
"/api/1.0/actions/sync": {
"get": {
"consumes": [
"application/json"
],
"description": "Get a list of all available synchronous actions in Business Central",
"operationId": "GetSynchronousActions",
"parameters": [
{
"$ref": "#/parameters/Url"
},
{
"$ref": "#/parameters/Company"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "string"
}
},
"400": {
"$ref": "#/responses/Unexpected"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"402": {
"$ref": "#/responses/InvalidLicense"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Unexpected"
}
},
"summary": "GetSynchronousActions",
"tags": [
"helpers"
],
"x-ms-visibility": "internal"
},
"post": {
"consumes": [
"application/json"
],
"description": "Perform a synchronous action in Business Central",
"operationId": "PerformSynchronousAction",
"parameters": [
{
"$ref": "#/parameters/Url"
},
{
"$ref": "#/parameters/Company"
},
{
"description": "Synchronous Action Request",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PerformSynchronousActionRequest"
},
"x-ms-summary": "Synchronous Action Request"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "string"
}
},
"400": {
"$ref": "#/responses/Unexpected"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"402": {
"$ref": "#/responses/InvalidLicense"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Unexpected"
}
},
"summary": "Perform a synchronous action",
"tags": [
"actions"
],
"x-ms-visibility": "important"
}
},
"/api/1.0/companies": {
"get": {
"consumes": [
Expand Down
136 changes: 135 additions & 1 deletion certified-connectors/Connect2All/apiDefinition.swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@
"basePath": "/",
"consumes": [],
"definitions": {
"Actiontype": {
"description": "The action type of the synchronous action that you wish to execute",
"title": "Action type",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetSynchronousActions",
"parameters": {
"Company": {
"parameter": "Company"
},
"Environment": {
"parameter": "Environment"
}
}
},
"x-ms-summary": "Action type"
},
"CodeunitId": {
"description": "The codeunit you wish to execute",
"format": "int32",
Expand Down Expand Up @@ -141,6 +158,22 @@
],
"type": "object"
},
"PerformSynchronousActionRequest": {
"properties": {
"actiontype": {
"$ref": "#/definitions/Actiontype"
},
"payload": {
"description": "The payload string to pass to the synchronous action",
"type": "string",
"x-ms-summary": "Payload String"
}
},
"required": [
"actiontype"
],
"type": "object"
},
"ReadRequest": {
"description": "The request to retrieve data",
"properties": {
Expand Down Expand Up @@ -501,7 +534,7 @@
},
"description": "Import, export and transform your Business Central data",
"title": "Connect2All",
"version": "2.3"
"version": "2.4"
},
"parameters": {
"Company": {
Expand Down Expand Up @@ -1412,6 +1445,107 @@
"x-ms-visibility": "important"
}
},
"/api/1.0/actions/sync": {
"get": {
"consumes": [
"application/json"
],
"description": "Get a list of all available synchronous actions in Business Central",
"operationId": "GetSynchronousActions",
"parameters": [
{
"$ref": "#/parameters/Environment"
},
{
"$ref": "#/parameters/Company"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "string"
}
},
"400": {
"$ref": "#/responses/Unexpected"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"402": {
"$ref": "#/responses/InvalidLicense"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Unexpected"
}
},
"summary": "GetSynchronousActions",
"tags": [
"helpers"
],
"x-ms-visibility": "internal"
},
"post": {
"consumes": [
"application/json"
],
"description": "Perform a synchronous action in Business Central",
"operationId": "PerformSynchronousAction",
"parameters": [
{
"$ref": "#/parameters/Environment"
},
{
"$ref": "#/parameters/Company"
},
{
"description": "Synchronous Action Request",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PerformSynchronousActionRequest"
},
"x-ms-summary": "Synchronous Action Request"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "string"
}
},
"400": {
"$ref": "#/responses/Unexpected"
},
"401": {
"$ref": "#/responses/Unauthorized"
},
"402": {
"$ref": "#/responses/InvalidLicense"
},
"404": {
"$ref": "#/responses/NotFound"
},
"500": {
"$ref": "#/responses/Unexpected"
}
},
"summary": "Perform a synchronous action",
"tags": [
"actions"
],
"x-ms-visibility": "important"
}
},
"/api/1.0/companies": {
"get": {
"consumes": [
Expand Down

0 comments on commit 7725bff

Please sign in to comment.