Publish service

Complete the actions to create a Spark service after Upload Excel file to Spark. Compilation must be complete before publishing, Check compilation status.

Returns: status of publish job.

POST /{tenant}/api/v3/folders/{folder}/services/{service}/publish

Authorization

• Bearer {token} accessible from Authorization - Bearer token or systematically via Client Credentials.

  • The request headers should include a key for Authorization with the value Bearer {token}.

• API key created from Authorization - API keys. The API key groups must contain User groups that are also assigned to Permissions - Features permissions Spark.ServicePublish.json or Spark.AllEncompassingProxy.json.

  • The request headers should include the keys x-synthetic-key and x-tenant-name with the API key and tenant name respectively.

Path parameters

Key	Value
tenant *	Tenant is part of your Log in to Spark URL and also available in the User menu.
folder *	Target folder name. This should be the same as in Upload Excel file to Spark.
service *	Target folder name. This should be the same as in Upload Excel file to Spark.

Request body

Content-Type: application/json

Key	Value
request_data.original_file_documentid *	id from Upload Excel file to Spark.
request_data.engine_file_documentid *	id from Upload Excel file to Spark.
request_data.draft_service_name *	Target service name overrides service from Upload Excel file to Spark.
request_data.version_label	Version label for service version. This will appear in the user interface dropdowns.
request_data.releasenote	Release note for service version.
request_data.effective_start_date	Timestamp to set the parameters for the Manage service versions and effective dates capability. Use Timestamp Converter to convert dates to ISO 8601. The value in Upload Excel file to Spark is ignored. Example: 2026-01-19T16:05:23.517Z
request_data.effective_end_date	Timestamp to set the parameters for the Manage service versions and effective dates capability. By default, the Spark UI will use the current date and time for this value. Use the Timestamp Converter to convert dates to ISO 8601. The value in Upload Excel file to Spark is ignored. Example: 2126-01-19T16:05:23.517Z
request_data.version_difference	major, minor, patch, or custom method of updating Semantic Versioning. This can be a different value than what was initially provided in Upload Excel file to Spark.
request_data.should_trck_user_action	"true" String boolean to set whether or not an Event would be recorded for this action. Events are visible in the Event viewer.
request_data.tags	Comma separated string of tags. Example: abc,def
request_data.description	Description for service version.
request_data.semantic_version	Semantic version needs to be populated if version_difference is custom.

Sample request

{
  "request_data": {
    "draft_service_name": "my service name",
    "version_label": "my service label",
    "effective_start_date": "2024-01-19T12:12:00.000Z",
    "effective_end_date": "2126-01-19T12:12:00.000Z",
    "original_file_documentid": "4c4cef82-3f30-45ae-ade8-b43f4ab29779",
    "engine_file_documentid": "d84bf685-2ed6-4d95-8fb1-d01770a0e0d8",
    "version_difference": "minor",
    "releasenote": "my release note",
    "description": "my description",
    "should_trck_user_action": "true"
  }
}

Sample response

HTTP 200 OK Content-Type: application/json

If the service name already exists, Spark will raise an error message.

{
    "status": "Success",
    "response_data": {
        "version_id": "7004e077-153f-4561-97ee-eb8124f6eb72"
    },
    "response_meta": {
        "system": "SPARK",
        "request_timestamp": "2023-05-18T21:20:42.498Z"
    },
    "error": null
}