Release Notes TIBCO Scribe® Developer Portal

Release notes are displayed in descending order from the most recent release to the oldest. Refer to Known Issues for additional information. See Release Notes And Known Issues for release notes associated with the TIBCO Scribe® User Interface. See TIBCO Cloud™ Integration - Connect Release Notes for release notes associated with the TIBCO Cloud™ Integration - Connect User Interface.

 

Version 2.11.0 Release

Released January 10, 2023.

New And Noteworthy

Upgraded the Swagger user interface to the latest version. As a result of this upgrade, the Try it out button on the interface is enabled by default and does not display. You can execute commands without having to select Try it out first. (SCCORE-8430)

Added a new Wait Block to the Control Blocks section of the Flow designer. This block allows you to pause the flow for up to 600,000 milliseconds (10 minutes). Note that if you stop a running app with a flow that contains a Wait Block, the app does not stop until the Wait Duration has completely elapsed. To use the Wait Block, you must run the latest version of the Agent. (SCCORE-8662)

 

Version 2.10.0 Release

Released July 14, 2022.

New And Noteworthy

Added a new parameter, byReference, to the POST /v1/orgs/{orgId}/solutions/{solutionId}/cloneAsync method. If set to true, the source Solution and any associated cloned target Solutions share resources, such as Maps. This improves performance when cloning. However, neither the source Solution nor the target Solutions can be edited. See Copy Or Clone A Solution Using Shared Resources for more information. (SCCORE-7751)

Added a new field to the Solution model to indicate whether or not a Solution has been cloned and is sharing resources. The new field and possible values are as follows: (IPAS-19950)

• solutionCloneType
  • solution — Solution does not share resources with any other Solution.
  • solutionByReferenceSource — Source Solution that has been copied to one or more target Solutions and shares resources with those Solutions, such as Maps.
  • solutionByReferenceTarget — Target Solution copied from a source Solution and shares resources with the source Solution, such as Maps.

Closed Issues

There are no Closed Issues in this release.

 

Version 2.9.1 Release

Released March 31, 2022

New And Noteworthy

There are no new features in this release.

Closed Issues

SCCORE-8065

After a Connector release or in cases where Cloud Agents are moved to other servers for load balancing, Connection details sometimes do not display in the Connection dialog of an existing connection. (Case # 02091495, 02091918, 02092834, 02093791, 02095721, 02095880)

Version 2.9.0 Release

Released March 8, 2022.

New And Noteworthy

There are no new features in this release.

Changes In Functionality

SCISV-255

Third-party Connector developers should note that the list of .dlls installed on an agent is changing with this release. For the updated list, see TIBCO Scribe® Online Connector Certification & Release on the Cloud Software Group Support site.

SCCORE-6824

Cloning large Solutions using the API sometimes generated HTTP Status Code 504 Gateway Time-out errors even though the server was not busy. (Case # 01942975, 02035644) To address this issue we have added a new API method that clones Solutions asynchronously. The clone is created in a thread and, using a second method, the status of the clone command can be polled.

• POST ​/v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync
• GET ​/v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync​/{cloneId}

The existing POST ​/v1​/orgs​/{orgId}​/solutions​/{solutionId}​/clone method will be deprecated in a future release. Best practice is to begin using the new API methods to clone Solutions as soon as possible.

SCCORE-5263, SCCORE-7135

Maps now support a maximum of 250 Blocks. If you have a Map that contains more than 250 Blocks it will continue to run. If you open a Map that contains more than 250 Blocks you cannot save any changes made to the Map until you reduce the number of Blocks. Best practice is to create several smaller Maps that run in sequence within a Solution.

Closed Issues

SCCORE-3564

Occasionally the status of a scheduled Solution is returned by the API as On Demand instead of Idle, however the Solution runs as scheduled. (Case # 01850686, 01852373, 01853709, 01859358, 01862357, 01882119, 01908242)

SCCORE-7220

The POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare method does not check for error conditions in metadata requests and continues the process, which eventually fails with an error similar to the following: Waiting for missing Field Metadata. (Case # 02050532)

Version 2.8.1 Patch 4 Release

New And Noteworthy

There are no new features in this release.

Closed Issues

SCCORE-6560 / SCCORE-6754

Deleting apps using the API sometimes generates 504 Gateway Time-out errors even though the server is not busy. With this release, overall time to delete may be increased but succeeds in situations where the load on the server is heavy. (Case # 01942975)

Version 2.7.0 Patch 1 Release

Released December 21, 2020.

New And Noteworthy

There are no new features in this release.

Closed Issues

SCCORE-5454 / SCCORE-5456

When cloning and preparing an app with hierarchical connections , loading associated metadata did not complete. In such cases, the flows in the app did not compile, but the prepare process returned a success message. (Case # 01901546)

SCCORE-5026 / SCCORE-5414

When cloning and preparing a Solution, the process appears to be successful, but when viewing the new Solution in the User Interface it remains in an Incomplete state and no error is generated. (Case # 01901546)

Version 2.7.0 Release

Released December 2, 2020.

New And Noteworthy

SCCORE-4823

Added new settings for storing failed records for reprocessing to the Organization models used in the GET and PUT Organization calls. Settings are interdependent and include the following:

• captureOnFailedRecordsForReprocessing — Enables/disables capturing any failed source records generated when a Solution runs. Applies to all Solutions in the Organization. Default setting is false. When set to false, all other failed records settings are ignored.
  • captureDuringCloudAppRuns — Enables/disables capturing failed records for Solutions run by the Cloud Agent. Records are stored in the Cloud. Default setting is false. If captureOnFailedRecordsForReprocessing is set to false, this setting is ignored.
  • captureDuringLocalAgentAppRuns — Enables/disables capturing failed records for Solutions run by the On- Premise Agent. Default setting is false. If captureOnFailedRecordsForReprocessing is set to false, this setting is ignored. If enabled, failed records are stored in the Cloud by default unless the following setting is set to true.
    • isSourceDataLocal — Enables/disables where to store failed records for Solutions run by the On-Premise Agent. If set to true, failed records are stored on the server where the Agent is installed. If set to false, failed records are stored in the Cloud. Default setting is false. If either captureOnFailedRecordsForReprocessing or captureDuringLocalAgentAppRuns is set to false, this setting is ignored.

SCCORE-3405

Added a new API that returns a list of the most recent set of metadata requests and the status of each request for a specific Connection.

GET ​/v1​/orgs​/{orgId}​/connections​/{connectionId}​/metadataRequests

SCCORE-3972

Added the expand flag to the GET /v1/orgs/{orgId}/connections/{connectionId} to enable or disable returning Connection properties. When set to true, returns Connection properties.

Version 2.6.5.3

Released October 8, 2020.

New And Noteworthy

There are no new features in this release.

Closed Issues

SCCORE-5002

Cloning and preparing a Solution when associated Maps contain entities without supported operations prevents the Solution from completing the Prepare process and may generate an error similar to the following: Waiting for missing Property Metadata. (Case # 01895944)

Version 2.6.5 Release

Released August 13, 2020.

New And Noteworthy

SCCORE-4703

Added the solutionAgentType field to the Solution model to indicate the type of Agent configured for the Solution. Agent types include OnPremise, Cloud, or None.

Closed Issues

There are no Closed Issues in this release.

Version 2.6.2 Release

Released May 26, 2020.

New And Noteworthy

SCCORE-3144

Added lastModificationDate and creationDate fields to the Solution model to indicate the date the Solution was created and the date it was last modified. These dates are returned in the Solution model, but are not required when creating or modifying a Solution. If included, these dates are ignored and are updated automatically by the system.

Changes In Functionality

SCCORE-3433

The isAgentLogDownloadAllowed field on the Organization model has been deprecated. It is no longer required because Agent logs can now be retrieved either via the Agent or the Solution APIs. If you use this field in a PUT or POST operation it is ignored.

Version 2.5.0 Release

Released March 4, 2020.

New And Noteworthy

There are no new features in this release.

Closed Issues

33953 / SCCORE-1564

If a user logged into TIBCO Scribe® using a different case for their user name, such as user1@tibco.com versus USER1@TIBCO.COM, that user could not unlock a Map that was locked in a prior session with the lower-case username. (Case # 89430)

Version 2.4.0 Release

Released November 19, 2019.

New And Noteworthy

Added Conditional Field Mapping options to the Block Properties Fields for target operation Blocks. Conditional Field Mapping allows you to control whether or not a value or field is written to a target datastore based on the contents of the source data. For example, if there is a NULL value in a source field, you can choose to overwrite target data with the NULL value or skip that field when updating a record. See fieldMappings and skipNullAssignments for additional information. (SCCORE-1299, 1224, 1223, 1222, 201)

Updated the Swagger page to a newer software version. (SCCORE-994)

Closed Issues

74276 / SCCORE-144

Retrieving information about an Event Solution using the API call

GET v1/orgs/<<orgid>>/solutions/<<sol id>> returned an incorrect value for lastRuntime.(Case # 69357, 01729477)

Version 2.3.0 Release

Released September 17, 2019.

New And Noteworthy

Agent

Additional information can be found on the Cloud Software Group Community.

Closed Issues

There are no Closed Issues in this release.

Version 2.2.0 Release

Released June 18, 2019.

New And Noteworthy

Logs

Added two APIs that can be used to retrieve Agent Logs from the Cloud Agent: (72565)

POST orgs/{orgId:int}/solutions/{solutionId:guid}/logs - Returns a logid that can be used with the GET API call to return the Agent log for a specific Solution.

GET orgs/{orgId:int}/solutions/{solutionid:guid}/logs/{logId} — Uses the logid generated by the POST API call to return the Agent log for a specific Solution.

Marketplace

Added filterByDescription search parameter that allows you to search for a Connector based on text in the Connector Description. When used with filterByName, the filters are treated as filter1 or filter2. For example, if filterByName contains Microsoft and filterByDescription contains Customer, Connectors with either Microsoft in the name or Customer in the description are returned. (63439)

Closed Issues

There are no Closed Issues in this release.

Version 2.0.3 Release

TIBCO Software Inc. released the Version 2.0.3 update to TIBCO Scribe® on October 19, 2018.

New And Noteworthy

Subscriptions

• Added a new endpoint, GET /v1/orgs/{orgId}/subscriptions{subscriptionId}, that returns subscription information for a single subscription ID. (63295)

Agent

Additional information can be found on the Cloud Software Group Community.

Closed Issues

Execution History

66046 / 66588 / 66844

Could not retrieve errors for Replication Services Solutions and Event Solutions containing Request/Reply Maps from either the API or the UI. From the API, the following error was generated: (Case # 65209)

Export with the specified id was not found.

Version 2.0.1 Release

Released August 1, 2018.

New And Noteworthy

• Requests to TIBCO Scribe® endpoints now timeout after 90 seconds instead of 60 seconds.

Closed Issues

There are no Closed Issues in this release.

April 6, 2018 Release

New And Noteworthy

Added the PUT /v1/orgs/{orgId}/connectors/{connectorId}/version endpoint to modify the locked/unlocked state of a Connector version. If locked, the Connector version on the Agents in that Organization is not automatically upgraded when TIBCO Software Inc. releases a new version of the Connector. (61587)

Added the GET /v1/orgs/{orgId}/connectors/{connectorId}/version endpoint to return the locked state and version of the selected Connector. (57826)

Added the POST /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId}/revert endpoint to revert a Map to a prior revision. (17233,57500)

Added the GET /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId}/revisions endpoint to return a list of revisions for a Map. Revisions are returned in descending order by revision number, which means that the latest revision is returned first. (57504)

Added a revision parameter to the following endpoints to return or export a specific revision of a Map based on the revision number: (57498, 60686)

• GET /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId}
• POST /v1/orgs/{orgId}/solutions/{solutionId}/maps/export

Added an optional comment parameter for Map revisions to the following endpoints: (17233, 60633)

• POST /v1/orgs/{orgId}/solutions/{solutionId}/maps/advanced
• PUT /v1/orgs/{orgId}/solutions/{solutionId}/maps/advanced/{mapId}

Enhanced the GET /v1/marketplace/connectors method to provide Connector Version information for all stored versions of a Connector including Hotfixes created after the last General Release version. (57825)

Enhanced the following Agent endpoints to return or save the ID and Version number of any installed Connectors: (57830)

• GET /v1/orgs/{orgId}/agents
• GET /v1/orgs/{orgId}/agents/{id}
• PUT /v1/orgs/{orgId}/agents/{id}

Added the following Agent and Solution statuses to both the User Interface and the TIBCO Scribe® API to provide more detail about the Agent’s current status: (5396, 19634)

• Waiting To Update Agent - Agent completes any Solution executions that are running and updates Execution History for running Solutions, but does not start any Solutions or contact TIBCO Scribe®. Agent then goes to Agent Updating status.
• Waiting To Update Connector - Agent completes any Solution executions that are running and updates Execution History for running Solutions, but does not start any new Solutions or contact TIBCO Scribe®. Agent then goes to Updating Connector status.
• Updating Connector – Agent is installing Connector updates.
• Waiting to restart, user requested - A user has requested an Agent restart. Depending on the type of restart selected by the user, the Agent restarts immediately or after all running Solutions are complete and Execution History has been updated.
• Waiting to restart, memory limit reached - TIBCO Scribe® detects when an Agent's memory limits are being exceeded and requests an Agent restart. Agent completes any running Solutions and updates Execution History for those Solutions before restarting.
• Restarting – Agent is restarting.

Deprecated And Removed Features

Removed API endpoints for Basic Maps from the API Swagger page since this map type is no longer supported in TIBCO Scribe®. (57524)

Closed Issues

There are no Closed Issues in this release.

January 19, 2018 Release

New And Noteworthy

Added two Agent endpoints used to retrieve On-Premise Agent log files: (55143)

POST /v1/orgs/{orgId}/agents/{agentId}/logs
GET /v1/orgs/{orgId}/agents/{agentId}/logs/{logId}

Added a checkForBulk parameter to enable Bulk Processing for a Replication Solution if the associated target Connector supports Bulk operations. The default value is false. This parameter is available for the following API endpoints: (51330)

POST /v1/orgs/{orgId}/solutions
PUT /v1/orgs/{orgId}/solutions/{solutionId}
PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

Closed Issues

There are no Closed Issues in this release.

August 8, 2017 Release

New And Noteworthy

Maps

Return a list of relationships for a Map (42161)

Upgrade a submitted Map to the latest version (46846)

If you attempt to use the Validate Map, Rename Block, or Preview Query Map endpoints with a Map saved as version 2.0 or lower, the TIBCO Scribe® API returns a message requiring you upgrade the to the latest Map version first. Use the POST /v1/orgs/{orgId}/solution/{solutionId}/maps/advanced/upgrade endpoint to upgrade an older Map model to the latest version. This does not save the Map it simply updates the Map submitted with the POST. You can then use the upgraded version with other Map API endpoints.

SDK

Enhanced the CDK tools to support building Connectors that can access and write Hierarchical Data.

Closed Issues

There are no Closed Issues in this release.

June 7, 2017 Release

New And Noteworthy

Added new endpoints to accomplish the following tasks:

Maps

• Duplicate Map (38442)
• Rename Blocks (36586)
• Change Block Operation Type (36587)
• Set Enable/Disable state (38307)
• Return preview data for the Fetch Block (38294)

Execution History

• View Statistics (37992)
• Export Errors (1932)

Lookup Tables

• Import/Export Lookup Table values (36661)

Fetch Block

When creating or modifying a Fetch Block you can use the following additional property to control the order of the results for the Fetch Block: (39227)

"sequences" : [{

"propertyName" : <Name of the property in the root entity of the Fetch to sort by>",

"direction" : "Ascending"

}

]

Connections

Added new query parameters to GET /v1/orgs/{orgId}/connections/{connectionId}/entities/{entityIdOrName}/relationships to set the number of levels to return for relationships and whether or not to flatten relationship data for property type relationships. (38042)

Managed Connectors

Added a new boolean property, isInMarketPlace, to the Managed Connector model to indicate whether or not the Connector is displayed in the TIBCO Scribe® Marketplace. (39524)

Maps

Added support for exporting selected Maps from a Solution instead of all Maps. (36599)

Organizations

Added the following parameters to the GET /v1/orgs endpoint: (38334)

• nameContains – Filter by a partial Organization name, for example, Smith to return Smith Industries.
• status – Filter by Organization status
• expandStatus – Include status in the response

Solutions

Added filter and sort options to the GET /v1/orgs/{orgId}/solutions/{solutionId} endpoint as follows: (21377)

Filter by:

• Name
• Type
• Status

Sort by:

• Name
• Type
• Status
• Last Start Time
• Next Start Time

Sort order:

• Ascending
• Descending

Closed Issues

There are no Closed Issues in this release.

January 2017 Release

New And Noteworthy

There are no new features in this release.

Closed Issues

20351

The GET /v1/orgs/{orgId}/solutions/{solutionId}/maps and GET /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId} API calls were returning an incorrect LastModificationDate field value for the Map.

22803

The GET /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId}/eventinfo API call did not return the correct state when the Map was changed from Complete to Incomplete.

Fall 2016 Release

This release includes all API calls which support virtually any function available in the UI. We have also implemented a new and improved help system with our API deployment which illustrates how these can be leveraged.

New And Noteworthy

Connectors

• Added Agent filter to the GET /v1/orgs/{orgId}/connectors method to return only those Connectors that are installed for the specified Agent. (21944)
• Added uiName and uiVersion parameters to the Connector model to indicate which User Interface should be loaded in TIBCO Scribe® for the Connection dialog when a Connection is configured. (28663)
• Updated the Connector model to include Marketplace details such as, Name, Supported Solution Types, Vendor URL, Description, Logo URL, Installed Status for the Organization, and whether it is free or must be requested. (28868)

Connections

• Test any Connection using only the Connection properties without saving the Connection. (25523)

Errors

• Errors returned from Errors endpoints now include whether or not the record with the error has been marked for reprocessing. (23108)
• Added the option to clear marks on error records that were marked for reprocessing using either the POST /v1/orgs/{orgId}/solutions/{solutionId}/history/{historyId}/errors/{id}/mark or the POST /v1/orgs/{orgId}/solutions{solutionId}/history/{id}/mark endpoints. (23113)

History

• Enhanced sorting and filtering options for Execution History APIs. (2806)

Organizations

• When creating a new Organization, unique names are no longer required. (22482)

Solutions

• Modified the POST /v1/orgs/{orgId}/solutions function to make Solution names unique by adding and auto-incrementing a number at the end of the name if a duplicate is submitted.(23897)

Register

• Updated the POST /v1/register API to include options for configuring Security Settings for the Organization being provisioned. (21009)

New API Calls

This release includes API calls that enable you to manage the following resources:

Connections

• Test Connection properties of an unsaved Connection

Connectors

• Setup call for a Connection to be created
• Return the status of a preconnect command
• Return UI options for a Connector

Maps

• Return the results of a Native Query Block test
• Test Native Query Block properties
• Import Maps
• Export Maps

Organizations

• Return a list of Message Endpoints
• Clear the Message queue
• Return a list of security rules
• Create a security rule
• Delete a security rule
• Return information about a security
• Modify a security rule
• Return a list of security settings
• Modify security settings
• Reset the Event Solution access token
• Reset the API encryption token
• Delete a User
• Return a list of Users
• Modify a User

Register

• Provision a new Organization for the specified User

Users

• Return your User information
• Modify your User information
• Return a list of email notification settings
• Modify email notification settings
• Return a list of Invitations
• Modify Invitation status

Deprecated And Removed Features

API support for Basic Maps has been deprecated as of the Fall 2016 release. Deprecated API calls include: 

Maps

• Create a Basic Map
• Update a Basic Map

Closed Issues

Agents

10332

The DELETE Agents API function returned a 500 error when attempting to delete a Cloud Agent, and the Agent was not deleted.

History

14124

When the exectutionId parameter was used in the GET History API function, the specified Solution Execution was not returned and a 400 error was generated.

14129

Removed the sortOrder parameter from the GET all History API function. Records are always returned in descending order.

Maps

24594

The POST /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId}/previewquery endpoint now returns error information in a JSON object instead of returning the error as a string.

22846

When validating a Formula in a Map using the POST /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId}/validate endpoint, if you provided the mapId of the Map containing the Formula, the validation failed.

21424

Using an Update/Insert Block in a Map generated incorrect validation errors. The Map was saved as an invalid Map and did not run.

Organizations

5586

If the Parent Organization's API Administrator was added during the creation of a Child Organization, the Child Organization had no subscriptions.

Spring 2016 Release

Released May 6, 2016.

We are thrilled to offer the Spring 2016 release. This release provides additional API features to help you automate Solution Management with TIBCO Scribe®. These API Calls are being released in anticipation of our major User Experience update later this year.

New And Noteworthy

• Paging maximum has been increased from 100 records to 500.
• Added an Agent filter to the GET Connections endpoint which is used to return only the Connections supported by the selected Agent.
• Added support for the Replication Services (RS) Solution type to the Solutions endpoints.

New API Calls

This release includes API calls that enable you to manage the following resources:

Agents

• Restart the Agent

Maps

• Prepare a Map to run
• Return the status of a Map prepare command
• Validate a Map
• Return results of Map validation
• Validate a Formula
• Return a Map link
• Preview source data from a Query

Organizations

• Return a list of settings
• Return a list of Functions

Closed Issues

19447

Corrected Maps API URLs to use /Solutions/ instead of /Solution/ to match the format of the Solutions API URLs. Exisiting Maps API URLs still work, however, best practice is to modify any application using those API URLs to the new format. The prior URLs that use /Solution/ will be removed in the future.

17904

Corrected misspelling in the Map model from RelationshipAlais to RelationshipAlias.

Winter 2016 Release

We are excited to offer the Winter 2016 release. This release provides some powerful API features to help you automate Solution Management with TIBCO Scribe®. These API Calls are being released in anticipation of our major release in 2016 to transform our User Experience.

New And Noteworthy

OAuth Connections

Support for creating OAuth connections via the TIBCO Scribe® API is being added gradually. In this release TIBCO has added support for creating OAuth connections for HubSpot.

New API Calls

This release includes API calls that enable you to manage the following resources:

Maps

• Return a list of Maps
• Return information about a Map
• Delete a Map
• Return information about an Event Map
• Lock an unlocked Map
• Run a single Map
• Return the status of the Run Map Now command
• Create an Advanced Map
• Update an Advanced Map
• Create a Basic Map
• Update a Basic Map

Connections

• Return a list of Actions for a Connection
• Return a list of Entities for a Connection
• Return information about an Entity
• Return a list of Fields for an Entity
• Return a list of Relationships for an Entity
• Return a list of Entity names for a Connection

Closed Issues

There are no Closed Issues in this release.

Fall 2015 Release

TIBCO Scribe® recently released the Fall 2015 update of the TIBCO Scribe® API, which includes support for additional TIBCO Scribe® resources, and support for corresponding API calls.

General

• Dates are now formatted in ISO8601 UTC format with the timezone at the end.
• Added support for creating OAuth Connections for the Eloqua Bulk API connector. Refer to the Overview page for additional information.

New API Calls

This release includes API calls that enable you to manage the following resources:

Connections

• Return a list of Entities for a Connection
• Return a list of Fields for an Entity
• Return a list of Entity names for a Connection
• Return a list of Actions for a Connection
• Return information about an Entity
• Return a list of Relationships for an Entity

Lookup Tables

• Return a list of Lookup Tables
• Create a Lookup Table
• Delete a Lookup Table
• Return information about a Lookup Table
• Modify a Lookup Table
• Return a list of Lookup Table Values for a Lookup Table
• Create a Lookup Table Value
• Delete a Lookup Table Value
• Return information about a Lookup Table Value
• Modify a Lookup Table Value
• Return Lookup Table Value1 based on Lookup Table Value2
• Return Lookup Table Value2 based on Lookup Table Value1

Closed Issues

There are no Closed Issues in this release.

Fall 2014 Release

Released October 2014.

New And Noteworthy

New API Interface

This release provides an updated interface, which includes the following sections:

• Overview - Introduction to the TIBCO Scribe® API and its REST API implementation, as well as tips and tricks on using the TIBCO Scribe® API.
• Endpoints - Interactive interface that provides information about and enables you to use the TIBCO Scribe® API calls.
• Release Notes - Summary of changes for each TIBCO Scribe® API release.

New API Calls

This release includes API calls that enable you to manage the following resources:

Agents

• Create a cloud Agent or return installation information about an on-premise Agent
• Modify Agent information
• Delete an Agent
• Return a list of Agents or information about a particular Agent

Connections

• Create a Connection
• Copy a Connection
• Delete a Connection
• Modify Connection information
• Reset the metadata for a Connection
• Return a list of Connections or information about an individual Connection
• Test a Connection and return the status of a Connection test command

Connectors

• Create a Connector on all Agents
• Uninstall a Connector from all Agents
• Return a list of Connectors or return information about an individual Connector

Customers

• Modify a customer Organization to grant or remove a customer Organization's access to a managed Connector
• Return a list of the customer Organizations with access to a managed Connector

Errors

• Mark an error for reprocessing
• Return a list of errors from a Solution execution or information about a particular Solution execution
• Failed Records
• Return information about the failed source record from a Solution execution

History

• Return a list of Solution executions or information about a particular Solution execution
• Mark all errors in a Solution execution for reprocessing
• Reprocess all marked errors in a Solution execution

InvitedUsers

• Invite a User to join an Organization
• Modify invited User information
• Delete an invited User
• Return a list of invited Users or return information about a particular invited User

Managed Connectors

• Return a list of the Connectors that are managed by an Organization or return information about a managed Connector

Organizations

• Create an Organization
• Delete an Organization
• Modify Organization information
• Return a list of all Organizations for a user or the child Organizations for a parent Organization

Solutions

• Create a Solution
• Copy an entire Solution into another Organization
• Return information about a Solution or about a Solution schedule
• Modify Solution information or a Solution schedule
• Delete a Solution
• Return a list of Solutions or information about a particular Solution
• Prepare a Solution to run or return the status of a Solution prepare command
• Start a Solution execution
• Stop a Solution execution

Subscriptions

• Return a list of Subscriptions

Deprecated And Removed Features

Deprecated API Methods

• The POST start Command and POST stop command methods have been deprecated. Use the POST start Solution and POST stop Solution methods, instead.

Removed API Methods

The following methods have been removed in this release:

• POST requestid
• POST messageid
• POST users

Closed Issues

There are no Closed Issues in this release.

See

Known Issues