Execute API (v3)

Execute the calculation from a Spark service. Depending on the desired reference parameter, different URI are available. See the documentation for more details. The code snippet for your Spark service APIs can be found in the API Tester Code Snippets using the OpenAI.

Reference by folder and service

post

request_meta version_id, version, and transaction_date can be used for version resolution.

Authorizations

bearerTokensyntheticKey & tenantName

AuthorizationstringRequired

Bearer token can be accessed from the user menu.

Path parameters

tenantstringRequired

Tenant is part of your login URL and also available in the user menu.

Example: mytenantname

folderstringRequired

Folder associated with the API call.

Example: myfoldername

servicestringRequired

Service associated with the API call.

Example: myservicename

Body

application/json

Responses

200

OK

application/json

post

/{tenant}/api/v3/folders/{folder}/services/{service}/execute

HTTPcURLJavaScriptPython

POST /{tenant}/api/v3/folders/{folder}/services/{service}/execute HTTP/1.1
Host: excel.myenvironmentname.coherent.global
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "request_data": {
    "inputs": {
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF": [
        {
          "E": "A",
          "F": 6
        },
        {
          "E": "B",
          "F": 8
        }
      ],
      "Single_A": 2,
      "Single_B": 4,
      "Single_C": "sample text",
      "Single_D": "2021-10-18",
      "Single_J_Error": "Z",
      "Solve_y_target": 0,
      "Single_XJ_In_G": 3,
      "Single_XJ_In_H": "",
      "Single_XJ_In_I": 2,
      "REPORT1": {
        "FileName": null
      }
    }
  },
  "request_meta": {
    "service_uri": "folders/API V3/services/Sample API Full",
    "service_id": "18c5a5fc-9949-4b1d-b802-ac367fc3599c",
    "version": "1.0.0",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "transaction_date": "2021-12-29T06:15:28.583Z",
    "call_purpose": "Spark - API Tester",
    "source_system": "SPARK",
    "correlation_id": null,
    "requested_output": null,
    "service_category": "#Default#",
    "compiler_type": "Neuron"
  }
}

200

OK

{
  "response_data": {
    "outputs": {
      "CSV1": "\"A\",\"B\",\"C\"\n\"1\",\"2\",\"3\"\n",
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF_function": [
        {
          "E": "AB",
          "F": 48
        }
      ],
      "Single_AB_function": 20,
      "Single_C_function": "SAMPLE TEXT",
      "Single_D_function": "2022-10-18",
      "Solve_x_calculated": 5.3579474132655,
      "Single_XJ_Out_G": 3,
      "Single_XJ_Out_H": "",
      "Single_XJ_Out_I": 2,
      "Solve1": {
        "TargetValue": "0",
        "ByChangingCellValue": "5.357947413265504",
        "Comments": "Goal was reached on iteration 9."
      },
      "REPORT1": {
        "PDFUrl": "https://excel.myenvironment.coherent.global/67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "PDFName": "67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "DocumentGenerationTime": "23",
        "PDFGenerationTime": "7"
      }
    },
    "warnings": [],
    "errors": [
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "SimpleServiceAplusB",
        "source_path": "$.Input.A",
        "message": "Input Not Valid"
      },
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "Sample API Full",
        "source_path": "$.Input.Xvalidate1",
        "message": "I am an Xvalidate error"
      }
    ]
  },
  "response_meta": {
    "service_id": "4bf0af24-0a24-49f1-bd02-c2a343eb8246",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "version": "1.0.0",
    "process_time": 2,
    "call_id": "372167af-ae77-4298-8f59-f45c0f98c4fe",
    "compiler_type": "Neuron",
    "compiler_version": "1.0.0",
    "source_hash": null,
    "engine_id": "B72FD22D775D5A9FA10BCFF183369BCB",
    "correlation_id": "",
    "system": "SPARK",
    "request_timestamp": "2021-12-29T06:15:32Z"
  }
}

Reference by service_id

post

request_meta version_id, version, and transaction_date can be used for version resolution.

Authorizations

bearerTokensyntheticKey & tenantName

AuthorizationstringRequired

Bearer token can be accessed from the user menu.

Path parameters

tenantstringRequired

Tenant is part of your login URL and also available in the user menu.

Example: mytenantname

serviceIdstring · uuidRequired

service_id of the requested service.

Example: 4bab4cc7-fde1-4315-871d-17a72c4c39a2

Body

application/json

Responses

200

OK

application/json

post

/{tenant}/api/v3/service/{serviceId}

HTTPcURLJavaScriptPython

POST /{tenant}/api/v3/service/{serviceId} HTTP/1.1
Host: excel.myenvironmentname.coherent.global
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "request_data": {
    "inputs": {
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF": [
        {
          "E": "A",
          "F": 6
        },
        {
          "E": "B",
          "F": 8
        }
      ],
      "Single_A": 2,
      "Single_B": 4,
      "Single_C": "sample text",
      "Single_D": "2021-10-18",
      "Single_J_Error": "Z",
      "Solve_y_target": 0,
      "Single_XJ_In_G": 3,
      "Single_XJ_In_H": "",
      "Single_XJ_In_I": 2,
      "REPORT1": {
        "FileName": null
      }
    }
  },
  "request_meta": {
    "service_uri": "folders/API V3/services/Sample API Full",
    "service_id": "18c5a5fc-9949-4b1d-b802-ac367fc3599c",
    "version": "1.0.0",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "transaction_date": "2021-12-29T06:15:28.583Z",
    "call_purpose": "Spark - API Tester",
    "source_system": "SPARK",
    "correlation_id": null,
    "requested_output": null,
    "service_category": "#Default#",
    "compiler_type": "Neuron"
  }
}

200

OK

{
  "response_data": {
    "outputs": {
      "CSV1": "\"A\",\"B\",\"C\"\n\"1\",\"2\",\"3\"\n",
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF_function": [
        {
          "E": "AB",
          "F": 48
        }
      ],
      "Single_AB_function": 20,
      "Single_C_function": "SAMPLE TEXT",
      "Single_D_function": "2022-10-18",
      "Solve_x_calculated": 5.3579474132655,
      "Single_XJ_Out_G": 3,
      "Single_XJ_Out_H": "",
      "Single_XJ_Out_I": 2,
      "Solve1": {
        "TargetValue": "0",
        "ByChangingCellValue": "5.357947413265504",
        "Comments": "Goal was reached on iteration 9."
      },
      "REPORT1": {
        "PDFUrl": "https://excel.myenvironment.coherent.global/67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "PDFName": "67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "DocumentGenerationTime": "23",
        "PDFGenerationTime": "7"
      }
    },
    "warnings": [],
    "errors": [
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "SimpleServiceAplusB",
        "source_path": "$.Input.A",
        "message": "Input Not Valid"
      },
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "Sample API Full",
        "source_path": "$.Input.Xvalidate1",
        "message": "I am an Xvalidate error"
      }
    ]
  },
  "response_meta": {
    "service_id": "4bf0af24-0a24-49f1-bd02-c2a343eb8246",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "version": "1.0.0",
    "process_time": 2,
    "call_id": "372167af-ae77-4298-8f59-f45c0f98c4fe",
    "compiler_type": "Neuron",
    "compiler_version": "1.0.0",
    "source_hash": null,
    "engine_id": "B72FD22D775D5A9FA10BCFF183369BCB",
    "correlation_id": "",
    "system": "SPARK",
    "request_timestamp": "2021-12-29T06:15:32Z"
  }
}

Reference by version_id

post

version_id is the most direct service version reference.

Authorizations

bearerTokensyntheticKey & tenantName

AuthorizationstringRequired

Bearer token can be accessed from the user menu.

Path parameters

tenantstringRequired

Tenant is part of your login URL and also available in the user menu.

Example: mytenantname

versionIdstring · uuidRequired

version_id of the requested service.

Example: 0fb13c76-8b9b-43da-b664-2b11eb11d5c3

Body

application/json

Responses

200

OK

application/json

post

/{tenant}/api/v3/version/{versionId}

HTTPcURLJavaScriptPython

POST /{tenant}/api/v3/version/{versionId} HTTP/1.1
Host: excel.myenvironmentname.coherent.global
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "request_data": {
    "inputs": {
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF": [
        {
          "E": "A",
          "F": 6
        },
        {
          "E": "B",
          "F": 8
        }
      ],
      "Single_A": 2,
      "Single_B": 4,
      "Single_C": "sample text",
      "Single_D": "2021-10-18",
      "Single_J_Error": "Z",
      "Solve_y_target": 0,
      "Single_XJ_In_G": 3,
      "Single_XJ_In_H": "",
      "Single_XJ_In_I": 2,
      "REPORT1": {
        "FileName": null
      }
    }
  },
  "request_meta": {
    "service_uri": "folders/API V3/services/Sample API Full",
    "service_id": "18c5a5fc-9949-4b1d-b802-ac367fc3599c",
    "version": "1.0.0",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "transaction_date": "2021-12-29T06:15:28.583Z",
    "call_purpose": "Spark - API Tester",
    "source_system": "SPARK",
    "correlation_id": null,
    "requested_output": null,
    "service_category": "#Default#",
    "compiler_type": "Neuron"
  }
}

200

OK

{
  "response_data": {
    "outputs": {
      "CSV1": "\"A\",\"B\",\"C\"\n\"1\",\"2\",\"3\"\n",
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF_function": [
        {
          "E": "AB",
          "F": 48
        }
      ],
      "Single_AB_function": 20,
      "Single_C_function": "SAMPLE TEXT",
      "Single_D_function": "2022-10-18",
      "Solve_x_calculated": 5.3579474132655,
      "Single_XJ_Out_G": 3,
      "Single_XJ_Out_H": "",
      "Single_XJ_Out_I": 2,
      "Solve1": {
        "TargetValue": "0",
        "ByChangingCellValue": "5.357947413265504",
        "Comments": "Goal was reached on iteration 9."
      },
      "REPORT1": {
        "PDFUrl": "https://excel.myenvironment.coherent.global/67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "PDFName": "67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "DocumentGenerationTime": "23",
        "PDFGenerationTime": "7"
      }
    },
    "warnings": [],
    "errors": [
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "SimpleServiceAplusB",
        "source_path": "$.Input.A",
        "message": "Input Not Valid"
      },
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "Sample API Full",
        "source_path": "$.Input.Xvalidate1",
        "message": "I am an Xvalidate error"
      }
    ]
  },
  "response_meta": {
    "service_id": "4bf0af24-0a24-49f1-bd02-c2a343eb8246",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "version": "1.0.0",
    "process_time": 2,
    "call_id": "372167af-ae77-4298-8f59-f45c0f98c4fe",
    "compiler_type": "Neuron",
    "compiler_version": "1.0.0",
    "source_hash": null,
    "engine_id": "B72FD22D775D5A9FA10BCFF183369BCB",
    "correlation_id": "",
    "system": "SPARK",
    "request_timestamp": "2021-12-29T06:15:32Z"
  }
}

Generic execute endpoint

post

Service reference must be defined in the request_meta.

Authorizations

bearerTokensyntheticKey & tenantName

AuthorizationstringRequired

Bearer token can be accessed from the user menu.

Path parameters

tenantstringRequired

Tenant is part of your login URL and also available in the user menu.

Example: mytenantname

Body

application/json

Responses

200

OK

application/json

post

/{tenant}/api/v3/execute

HTTPcURLJavaScriptPython

POST /{tenant}/api/v3/execute HTTP/1.1
Host: excel.myenvironmentname.coherent.global
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "request_data": {
    "inputs": {
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF": [
        {
          "E": "A",
          "F": 6
        },
        {
          "E": "B",
          "F": 8
        }
      ],
      "Single_A": 2,
      "Single_B": 4,
      "Single_C": "sample text",
      "Single_D": "2021-10-18",
      "Single_J_Error": "Z",
      "Solve_y_target": 0,
      "Single_XJ_In_G": 3,
      "Single_XJ_In_H": "",
      "Single_XJ_In_I": 2,
      "REPORT1": {
        "FileName": null
      }
    }
  },
  "request_meta": {
    "service_uri": "folders/API V3/services/Sample API Full",
    "service_id": "18c5a5fc-9949-4b1d-b802-ac367fc3599c",
    "version": "1.0.0",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "transaction_date": "2021-12-29T06:15:28.583Z",
    "call_purpose": "Spark - API Tester",
    "source_system": "SPARK",
    "correlation_id": null,
    "requested_output": null,
    "service_category": "#Default#",
    "compiler_type": "Neuron"
  }
}

200

OK

{
  "response_data": {
    "outputs": {
      "CSV1": "\"A\",\"B\",\"C\"\n\"1\",\"2\",\"3\"\n",
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF_function": [
        {
          "E": "AB",
          "F": 48
        }
      ],
      "Single_AB_function": 20,
      "Single_C_function": "SAMPLE TEXT",
      "Single_D_function": "2022-10-18",
      "Solve_x_calculated": 5.3579474132655,
      "Single_XJ_Out_G": 3,
      "Single_XJ_Out_H": "",
      "Single_XJ_Out_I": 2,
      "Solve1": {
        "TargetValue": "0",
        "ByChangingCellValue": "5.357947413265504",
        "Comments": "Goal was reached on iteration 9."
      },
      "REPORT1": {
        "PDFUrl": "https://excel.myenvironment.coherent.global/67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "PDFName": "67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "DocumentGenerationTime": "23",
        "PDFGenerationTime": "7"
      }
    },
    "warnings": [],
    "errors": [
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "SimpleServiceAplusB",
        "source_path": "$.Input.A",
        "message": "Input Not Valid"
      },
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "Sample API Full",
        "source_path": "$.Input.Xvalidate1",
        "message": "I am an Xvalidate error"
      }
    ]
  },
  "response_meta": {
    "service_id": "4bf0af24-0a24-49f1-bd02-c2a343eb8246",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "version": "1.0.0",
    "process_time": 2,
    "call_id": "372167af-ae77-4298-8f59-f45c0f98c4fe",
    "compiler_type": "Neuron",
    "compiler_version": "1.0.0",
    "source_hash": null,
    "engine_id": "B72FD22D775D5A9FA10BCFF183369BCB",
    "correlation_id": "",
    "system": "SPARK",
    "request_timestamp": "2021-12-29T06:15:32Z"
  }
}

Generic v3 endpoint

post

Service reference must be defined in the request_meta.

Authorizations

bearerToken

AuthorizationstringRequired

Bearer token can be accessed from the user menu.

Path parameters

tenantstringRequired

Tenant is part of your login URL and also available in the user menu.

Example: mytenantname

Body

application/json

Responses

200

OK

application/json

post

/{tenant}/api/v3

HTTPcURLJavaScriptPython

POST /{tenant}/api/v3 HTTP/1.1
Host: excel.myenvironmentname.coherent.global
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "request_data": {
    "inputs": {
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF": [
        {
          "E": "A",
          "F": 6
        },
        {
          "E": "B",
          "F": 8
        }
      ],
      "Single_A": 2,
      "Single_B": 4,
      "Single_C": "sample text",
      "Single_D": "2021-10-18",
      "Single_J_Error": "Z",
      "Solve_y_target": 0,
      "Single_XJ_In_G": 3,
      "Single_XJ_In_H": "",
      "Single_XJ_In_I": 2,
      "REPORT1": {
        "FileName": null
      }
    }
  },
  "request_meta": {
    "service_uri": "folders/API V3/services/Sample API Full",
    "service_id": "18c5a5fc-9949-4b1d-b802-ac367fc3599c",
    "version": "1.0.0",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "transaction_date": "2021-12-29T06:15:28.583Z",
    "call_purpose": "Spark - API Tester",
    "source_system": "SPARK",
    "correlation_id": null,
    "requested_output": null,
    "service_category": "#Default#",
    "compiler_type": "Neuron"
  }
}

200

OK

{
  "response_data": {
    "outputs": {
      "CSV1": "\"A\",\"B\",\"C\"\n\"1\",\"2\",\"3\"\n",
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF_function": [
        {
          "E": "AB",
          "F": 48
        }
      ],
      "Single_AB_function": 20,
      "Single_C_function": "SAMPLE TEXT",
      "Single_D_function": "2022-10-18",
      "Solve_x_calculated": 5.3579474132655,
      "Single_XJ_Out_G": 3,
      "Single_XJ_Out_H": "",
      "Single_XJ_Out_I": 2,
      "Solve1": {
        "TargetValue": "0",
        "ByChangingCellValue": "5.357947413265504",
        "Comments": "Goal was reached on iteration 9."
      },
      "REPORT1": {
        "PDFUrl": "https://excel.myenvironment.coherent.global/67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "PDFName": "67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "DocumentGenerationTime": "23",
        "PDFGenerationTime": "7"
      }
    },
    "warnings": [],
    "errors": [
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "SimpleServiceAplusB",
        "source_path": "$.Input.A",
        "message": "Input Not Valid"
      },
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "Sample API Full",
        "source_path": "$.Input.Xvalidate1",
        "message": "I am an Xvalidate error"
      }
    ]
  },
  "response_meta": {
    "service_id": "4bf0af24-0a24-49f1-bd02-c2a343eb8246",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "version": "1.0.0",
    "process_time": 2,
    "call_id": "372167af-ae77-4298-8f59-f45c0f98c4fe",
    "compiler_type": "Neuron",
    "compiler_version": "1.0.0",
    "source_hash": null,
    "engine_id": "B72FD22D775D5A9FA10BCFF183369BCB",
    "correlation_id": "",
    "system": "SPARK",
    "request_timestamp": "2021-12-29T06:15:32Z"
  }
}

Public API reference by folder and service

post

request_meta version_id, version, and transaction_date can be used for version resolution.

Authorizations

bearerTokentenantNamesyntheticKey

AuthorizationstringRequired

Bearer token can be accessed from the user menu.

Path parameters

tenantstringRequired

Tenant is part of your login URL and also available in the user menu.

Example: mytenantname

folderstringRequired

Folder associated with the API call.

Example: myfoldername

servicestringRequired

Service associated with the API call.

Example: myservicename

Body

application/json

Responses

200

OK

application/json

post

/{tenant}/api/v3/public/folders/{folder}/services/{service}/execute

HTTPcURLJavaScriptPython

POST /{tenant}/api/v3/public/folders/{folder}/services/{service}/execute HTTP/1.1
Host: excel.myenvironmentname.coherent.global
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "request_data": {
    "inputs": {
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF": [
        {
          "E": "A",
          "F": 6
        },
        {
          "E": "B",
          "F": 8
        }
      ],
      "Single_A": 2,
      "Single_B": 4,
      "Single_C": "sample text",
      "Single_D": "2021-10-18",
      "Single_J_Error": "Z",
      "Solve_y_target": 0,
      "Single_XJ_In_G": 3,
      "Single_XJ_In_H": "",
      "Single_XJ_In_I": 2,
      "REPORT1": {
        "FileName": null
      }
    }
  },
  "request_meta": {
    "service_uri": "folders/API V3/services/Sample API Full",
    "service_id": "18c5a5fc-9949-4b1d-b802-ac367fc3599c",
    "version": "1.0.0",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "transaction_date": "2021-12-29T06:15:28.583Z",
    "call_purpose": "Spark - API Tester",
    "source_system": "SPARK",
    "correlation_id": null,
    "requested_output": null,
    "service_category": "#Default#",
    "compiler_type": "Neuron"
  }
}

200

OK

{
  "response_data": {
    "outputs": {
      "CSV1": "\"A\",\"B\",\"C\"\n\"1\",\"2\",\"3\"\n",
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF_function": [
        {
          "E": "AB",
          "F": 48
        }
      ],
      "Single_AB_function": 20,
      "Single_C_function": "SAMPLE TEXT",
      "Single_D_function": "2022-10-18",
      "Solve_x_calculated": 5.3579474132655,
      "Single_XJ_Out_G": 3,
      "Single_XJ_Out_H": "",
      "Single_XJ_Out_I": 2,
      "Solve1": {
        "TargetValue": "0",
        "ByChangingCellValue": "5.357947413265504",
        "Comments": "Goal was reached on iteration 9."
      },
      "REPORT1": {
        "PDFUrl": "https://excel.myenvironment.coherent.global/67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "PDFName": "67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "DocumentGenerationTime": "23",
        "PDFGenerationTime": "7"
      }
    },
    "warnings": [],
    "errors": [
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "SimpleServiceAplusB",
        "source_path": "$.Input.A",
        "message": "Input Not Valid"
      },
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "Sample API Full",
        "source_path": "$.Input.Xvalidate1",
        "message": "I am an Xvalidate error"
      }
    ]
  },
  "response_meta": {
    "service_id": "4bf0af24-0a24-49f1-bd02-c2a343eb8246",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "version": "1.0.0",
    "process_time": 2,
    "call_id": "372167af-ae77-4298-8f59-f45c0f98c4fe",
    "compiler_type": "Neuron",
    "compiler_version": "1.0.0",
    "source_hash": null,
    "engine_id": "B72FD22D775D5A9FA10BCFF183369BCB",
    "correlation_id": "",
    "system": "SPARK",
    "request_timestamp": "2021-12-29T06:15:32Z"
  }
}

Public API reference by service_id

post

request_meta version_id, version, and transaction_date can be used for version resolution.

Authorizations

bearerTokentenantNamesyntheticKey

AuthorizationstringRequired

Bearer token can be accessed from the user menu.

Path parameters

tenantstringRequired

Tenant is part of your login URL and also available in the user menu.

Example: mytenantname

serviceIdstring · uuidRequired

service_id of the requested service.

Example: 4bab4cc7-fde1-4315-871d-17a72c4c39a2

Body

application/json

Responses

200

OK

application/json

post

/{tenant}/api/v3/public/service/{serviceId}

HTTPcURLJavaScriptPython

POST /{tenant}/api/v3/public/service/{serviceId} HTTP/1.1
Host: excel.myenvironmentname.coherent.global
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "request_data": {
    "inputs": {
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF": [
        {
          "E": "A",
          "F": 6
        },
        {
          "E": "B",
          "F": 8
        }
      ],
      "Single_A": 2,
      "Single_B": 4,
      "Single_C": "sample text",
      "Single_D": "2021-10-18",
      "Single_J_Error": "Z",
      "Solve_y_target": 0,
      "Single_XJ_In_G": 3,
      "Single_XJ_In_H": "",
      "Single_XJ_In_I": 2,
      "REPORT1": {
        "FileName": null
      }
    }
  },
  "request_meta": {
    "service_uri": "folders/API V3/services/Sample API Full",
    "service_id": "18c5a5fc-9949-4b1d-b802-ac367fc3599c",
    "version": "1.0.0",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "transaction_date": "2021-12-29T06:15:28.583Z",
    "call_purpose": "Spark - API Tester",
    "source_system": "SPARK",
    "correlation_id": null,
    "requested_output": null,
    "service_category": "#Default#",
    "compiler_type": "Neuron"
  }
}

200

OK

{
  "response_data": {
    "outputs": {
      "CSV1": "\"A\",\"B\",\"C\"\n\"1\",\"2\",\"3\"\n",
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF_function": [
        {
          "E": "AB",
          "F": 48
        }
      ],
      "Single_AB_function": 20,
      "Single_C_function": "SAMPLE TEXT",
      "Single_D_function": "2022-10-18",
      "Solve_x_calculated": 5.3579474132655,
      "Single_XJ_Out_G": 3,
      "Single_XJ_Out_H": "",
      "Single_XJ_Out_I": 2,
      "Solve1": {
        "TargetValue": "0",
        "ByChangingCellValue": "5.357947413265504",
        "Comments": "Goal was reached on iteration 9."
      },
      "REPORT1": {
        "PDFUrl": "https://excel.myenvironment.coherent.global/67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "PDFName": "67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "DocumentGenerationTime": "23",
        "PDFGenerationTime": "7"
      }
    },
    "warnings": [],
    "errors": [
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "SimpleServiceAplusB",
        "source_path": "$.Input.A",
        "message": "Input Not Valid"
      },
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "Sample API Full",
        "source_path": "$.Input.Xvalidate1",
        "message": "I am an Xvalidate error"
      }
    ]
  },
  "response_meta": {
    "service_id": "4bf0af24-0a24-49f1-bd02-c2a343eb8246",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "version": "1.0.0",
    "process_time": 2,
    "call_id": "372167af-ae77-4298-8f59-f45c0f98c4fe",
    "compiler_type": "Neuron",
    "compiler_version": "1.0.0",
    "source_hash": null,
    "engine_id": "B72FD22D775D5A9FA10BCFF183369BCB",
    "correlation_id": "",
    "system": "SPARK",
    "request_timestamp": "2021-12-29T06:15:32Z"
  }
}

Public API reference by version_id

post

version_id is the most direct service version reference.

Authorizations

bearerTokentenantNamesyntheticKey

AuthorizationstringRequired

Bearer token can be accessed from the user menu.

Path parameters

tenantstringRequired

Tenant is part of your login URL and also available in the user menu.

Example: mytenantname

versionIdstring · uuidRequired

version_id of the requested service.

Example: 0fb13c76-8b9b-43da-b664-2b11eb11d5c3

Body

application/json

Responses

200

OK

application/json

post

/{tenant}/api/v3/public/version/{versionId}

HTTPcURLJavaScriptPython

POST /{tenant}/api/v3/public/version/{versionId} HTTP/1.1
Host: excel.myenvironmentname.coherent.global
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "request_data": {
    "inputs": {
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF": [
        {
          "E": "A",
          "F": 6
        },
        {
          "E": "B",
          "F": 8
        }
      ],
      "Single_A": 2,
      "Single_B": 4,
      "Single_C": "sample text",
      "Single_D": "2021-10-18",
      "Single_J_Error": "Z",
      "Solve_y_target": 0,
      "Single_XJ_In_G": 3,
      "Single_XJ_In_H": "",
      "Single_XJ_In_I": 2,
      "REPORT1": {
        "FileName": null
      }
    }
  },
  "request_meta": {
    "service_uri": "folders/API V3/services/Sample API Full",
    "service_id": "18c5a5fc-9949-4b1d-b802-ac367fc3599c",
    "version": "1.0.0",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "transaction_date": "2021-12-29T06:15:28.583Z",
    "call_purpose": "Spark - API Tester",
    "source_system": "SPARK",
    "correlation_id": null,
    "requested_output": null,
    "service_category": "#Default#",
    "compiler_type": "Neuron"
  }
}

200

OK

{
  "response_data": {
    "outputs": {
      "CSV1": "\"A\",\"B\",\"C\"\n\"1\",\"2\",\"3\"\n",
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF_function": [
        {
          "E": "AB",
          "F": 48
        }
      ],
      "Single_AB_function": 20,
      "Single_C_function": "SAMPLE TEXT",
      "Single_D_function": "2022-10-18",
      "Solve_x_calculated": 5.3579474132655,
      "Single_XJ_Out_G": 3,
      "Single_XJ_Out_H": "",
      "Single_XJ_Out_I": 2,
      "Solve1": {
        "TargetValue": "0",
        "ByChangingCellValue": "5.357947413265504",
        "Comments": "Goal was reached on iteration 9."
      },
      "REPORT1": {
        "PDFUrl": "https://excel.myenvironment.coherent.global/67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "PDFName": "67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "DocumentGenerationTime": "23",
        "PDFGenerationTime": "7"
      }
    },
    "warnings": [],
    "errors": [
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "SimpleServiceAplusB",
        "source_path": "$.Input.A",
        "message": "Input Not Valid"
      },
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "Sample API Full",
        "source_path": "$.Input.Xvalidate1",
        "message": "I am an Xvalidate error"
      }
    ]
  },
  "response_meta": {
    "service_id": "4bf0af24-0a24-49f1-bd02-c2a343eb8246",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "version": "1.0.0",
    "process_time": 2,
    "call_id": "372167af-ae77-4298-8f59-f45c0f98c4fe",
    "compiler_type": "Neuron",
    "compiler_version": "1.0.0",
    "source_hash": null,
    "engine_id": "B72FD22D775D5A9FA10BCFF183369BCB",
    "correlation_id": "",
    "system": "SPARK",
    "request_timestamp": "2021-12-29T06:15:32Z"
  }
}

Reference for custom endpoints

post

The request_meta version_id, version, and transaction_date can be used for version resolution.

Authorizations

bearerTokensyntheticKey & tenantName

AuthorizationstringRequired

Bearer token can be accessed from the user menu.

Path parameters

tenantstringRequired

Tenant is part of your login URL and also available in the user menu.

Example: mytenantname

urlsuffixstringRequired

Custom endpoints path.

Body

application/json

Responses

200

OK

application/json

post

/{tenant}/api/v3/proxy/{urlsuffix}

HTTPcURLJavaScriptPython

POST /{tenant}/api/v3/proxy/{urlsuffix} HTTP/1.1
Host: excel.myenvironmentname.coherent.global
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "request_data": {
    "inputs": {
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF": [
        {
          "E": "A",
          "F": 6
        },
        {
          "E": "B",
          "F": 8
        }
      ],
      "Single_A": 2,
      "Single_B": 4,
      "Single_C": "sample text",
      "Single_D": "2021-10-18",
      "Single_J_Error": "Z",
      "Solve_y_target": 0,
      "Single_XJ_In_G": 3,
      "Single_XJ_In_H": "",
      "Single_XJ_In_I": 2,
      "REPORT1": {
        "FileName": null
      }
    }
  },
  "request_meta": {
    "service_uri": "folders/API V3/services/Sample API Full",
    "service_id": "18c5a5fc-9949-4b1d-b802-ac367fc3599c",
    "version": "1.0.0",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "transaction_date": "2021-12-29T06:15:28.583Z",
    "call_purpose": "Spark - API Tester",
    "source_system": "SPARK",
    "correlation_id": null,
    "requested_output": null,
    "service_category": "#Default#",
    "compiler_type": "Neuron"
  }
}

200

OK

{
  "response_data": {
    "outputs": {
      "CSV1": "\"A\",\"B\",\"C\"\n\"1\",\"2\",\"3\"\n",
      "Chain_a": 4,
      "Chain_b": 2,
      "Range_EF_function": [
        {
          "E": "AB",
          "F": 48
        }
      ],
      "Single_AB_function": 20,
      "Single_C_function": "SAMPLE TEXT",
      "Single_D_function": "2022-10-18",
      "Solve_x_calculated": 5.3579474132655,
      "Single_XJ_Out_G": 3,
      "Single_XJ_Out_H": "",
      "Single_XJ_Out_I": 2,
      "Solve1": {
        "TargetValue": "0",
        "ByChangingCellValue": "5.357947413265504",
        "Comments": "Goal was reached on iteration 9."
      },
      "REPORT1": {
        "PDFUrl": "https://excel.myenvironment.coherent.global/67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "PDFName": "67a1a340-3f06-4db1-a4b8-316757d03d07.pdf",
        "DocumentGenerationTime": "23",
        "PDFGenerationTime": "7"
      }
    },
    "warnings": [],
    "errors": [
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "SimpleServiceAplusB",
        "source_path": "$.Input.A",
        "message": "Input Not Valid"
      },
      {
        "error_category": "validation_error",
        "error_type": "error.VALIDATION",
        "additional_details": "Sample API Full",
        "source_path": "$.Input.Xvalidate1",
        "message": "I am an Xvalidate error"
      }
    ]
  },
  "response_meta": {
    "service_id": "4bf0af24-0a24-49f1-bd02-c2a343eb8246",
    "version_id": "d5b2b3b3-8d79-41b1-a9c3-3d9652687204",
    "version": "1.0.0",
    "process_time": 2,
    "call_id": "372167af-ae77-4298-8f59-f45c0f98c4fe",
    "compiler_type": "Neuron",
    "compiler_version": "1.0.0",
    "source_hash": null,
    "engine_id": "B72FD22D775D5A9FA10BCFF183369BCB",
    "correlation_id": "",
    "system": "SPARK",
    "request_timestamp": "2021-12-29T06:15:32Z"
  }
}