Solutions

A Solution is the set of user-specified configuration options that allows TIBCO Scribe® to perform a specific task, such as replicating or integrating entities or fields from a source account to a target database. Solutions contain an Agent, mapping instructions, and Connection information. These items function in concert to move data from one datastore to another. Each Solution type provides different functionality and options. See Solutions in the TIBCO Scribe® Help.

Preparing a Solution

When creating or modifying a Solution, you must run a prepare command for the Solution. This is a lengthy process that gathers all the Connections used in the Solution, gathers all the metadata that the Solution requires, and tries to compile each Map. This requires that the Agent and any Connections that the Solution uses are up, available, and valid. Because this is an asynchronous process, the method returns information that includes an ID that you can use to query the results of the POST prepare Solution method with GET /v1/orgs/{orgId}/solutions/{solutionId}/prepare/{prepareId}.

When running the POST prepare Solution method on a Solution that was cloned or that contains imported Maps, TIBCO Scribe® updates any Event Maps during the compile process with a new Endpoint URL based on the new Map IDs and the Data Center associated with the Organization. Be sure to update any applications that send messages to TIBCO Scribe® with the new URL.

Other endpoints associated with Solutions include: 

  • Maps — Maps are a set of instructions used by TIBCO Scribe® that run sequentially to integrate or migrate data. Use the Maps endpoints to view, create, modify, delete, run, or lock and unlock Maps. See Managing Maps in the TIBCO Scribe® Help.
  • Blocks — Blocks are used in Maps to represent individual operations. For example, the Query Block, allows you to create an operation similar to a SQL SELECT statement to define which source entity and source records should be included in the Map.

Before using the TIBCO Scribe® API to create, update, or delete Maps or Solutions, review the following How Do I... topics:

Use the Solutions endpoints to view, create, modify, and delete Solution information.

Endpoints—Use the links in the Endpoints section below to access the TIBCO Scribe® Swagger page and try out the API against your Organization.

Fields for Solutions Endpoints—Review the field definition table below the list of Endpoints for detailed field level information.

Considerations

In some cases there are special considerations or use cases for specific endpoints that you should know about before you use the endpoint.

Solutions with Shared Resources

If you copy or clone a Solution with the byReference parameter enabled, the source and target Solutions share resources. Some API methods are not supported for these types of Solutions. See Copy Or Clone A Solution Using Shared Resources for considerations related to Solutions with shared resources.

POST /v1/orgs/{orgId}/solutions

  • The created Solution is incomplete until a Solutions POST prepare command is issued against it.

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

  • Use the index value to change the order of Maps. You cannot add or remove Maps.
  • Modifying a source Connection in a Replication Solution requires redefining entities. TIBCO recommends creating a new Replication Solution if you need to modify either the source or the target Connection in your Replication Solution. If you choose to do the modification, be sure to specify Source entities again.
  • Modifying a Replication Solution generates an error if the mapLinks are not included. However, Replication Solutions do not contain Maps, and have no associated mapLinks.

    Workaround: Make sure mapLinks is entered as follows in the model:

    "mapLinks": [],

POST /v1/orgs/{orgId}/solutions/{solutionId}/cloneAsync

  • To clone a Solution successfully, all Maps in the source Solution must be valid, and the destination Organization must use the same Connection type and names. The cloned Solution is incomplete until a Solutions POST prepare command is issued against it.
  • The most recent revision of each Map in the Solution is used.

POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

  • This method is being deprecated in a future release. Best practice is to use the POST ​/v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync method instead.

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

  • The model for a Solution schedule supports a complex hierarchy. See the TIBCO Scribe® user interface to identify the required fields for the defined schedule type.

POST /v1/orgs/{orgId}/solutions/{solutionId}/start

  • This call is ignored if the Solution is running. Use this command instead of Commands POST start.

POST /v1/orgs/{orgId}/solutions/{solutionId}/startmonitor

  • Use this call to return the number of records processed so far while a Solution is executing.

POST /v1/orgs/{orgId}/solutions/{solutionId}/stop

  • If you stop a running Solution with a Map that contains a Wait Block, the Solution does not stop until the time configured in the Wait Block has elapsed.

Endpoints

Return a list of Solutions

Create a Solution

Return information about a Solution

Copy an entire Solution into another Organization (Replaced by CloneAsync)

Copy an entire Solution into another Organization asynchronously

Return the status of the asynchronous clone command

Return information about Connections for a Solution

Prepare a Solution to run

Return the status of a Solution prepare command

Return information about a schedule for a Solution

Modify a schedule for a Solution

Start a Solution execution

Start monitoring a Solution when it runs

Stop a Solution execution

Stop monitoring a Solution when it runs

Fields for Solutions Endpoints

The list of fields defined in this table is comprehensive across all Solutions endpoints. See Endpoints for a list of Solutions endpoints with links to the associated Swagger page.

Name
Type
Data Type

Description

Endpoints

Parameters

byReference

query

boolean

Solutions cloned or copied with this parameter enabled share resources with the source Solution, such as Maps. Default is false. See Copy Or Clone A Solution Using Shared Resources.

  • true - Enable shared resources.
  • false - Disable shared resources.
  • Blank - If this field is empty, the setting is ignored and no resources are shared.

Note: Not supported for Replication and Event Solutions.

  • POST /v1/orgs/{orgId}/solutions/{solutionId}/cloneAsync

checkForBulk

query

boolean

Enables bulk processing for a Replication Solution if supported by the connections in the Solution. Default value is false.

  • true - Enable bulk processing
  • false - Disable bulk processing
  • POST /v1/orgs/{orgId}/solutions
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

destAgentId

query

integer

ID of the Agent assigned to execute this Solution in the target Organization to which you are sending a cloned Solution. Required. See Copy Or Clone A Solution To Another Organization.

  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/cloneAsync

destOrgId

query

integer

ID of the Organization to which you are sending a cloned Solution. Required. See Copy Or Clone A Solution To Another Organization.

  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/cloneAsync

limit

query

integer

Maximum number of Solutions to return. Default value is 100.

See Reading Resources for more information on offset and limit parameters.

  • GET /v1/orgs/{orgId}/solutions

offset

query

integer

Number of Solutions to skip before returning results. Default value is 0.  

See Reading Resources for more information on offset and limit parameters.

  • GET /v1/orgs/{orgId}/solutions

model

body

model

Model for the Solution. Required

Model for the Solution Schedule. Required

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

orgId

path

integer

Unique ID for each Organization. Required

All

prepareId

path

string

ID of the Solution Prepare job started with the POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare method.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/prepare/{prepareId}

solutionId

path

string

GUID/UUID of the Solution. Required

  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/cloneAsync
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/connections
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/prepare/{prepareId}
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/start
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/startmonitor
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/stop
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/stopmonitor

solutionNameFilter

query

string

Filters data by the name of a specific Solution.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}

solutionType

query

string

Filters data by the type of Solution. See solutionType for a list of types.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}

solutionStatusFilter

query

string

Filters data by the status of a specific Solution. See status for a list of statuses.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}

sortName

query

string

Sort Solutions by one of the following items:

  • Name — Solution name.
  • Type — Solution type. See solutionType for a list of types.
  • Status — Solution status. See status for a list of statuses.
  • LastStartTime — Date and time in UTC that the Solution last started running.
  • NextStartTime — For Scheduled Solutions, the date and time in UTC when the Solution is scheduled to run next.

Default value is Name. See sortOrder to set ascending or descending record order.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}

sortOrder

query

string

Sets the order of records when sorted using sortName. Default is asc.

  • asc — Sort in ascending order, such as 1,2,3.
  • desc — Sort in descending order, such as 3,2,1.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}

Response

agentId

response

string

GUID / UUID of the Agent assigned to execute this Solution.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

clonedSolutionId

response

string

GUID/UUID of the new Solution created using the asynchronous clone command.

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

connectionID

response

string

GUID/UUID of a Connection used in one or more Maps in the Solution.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/connections

connectionIdForSource

response

string

GUID/UUID of the source Connection in a Replication Services Solution. For other types of Solutions the Connection information is stored in an associated Map. See Maps.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

connectionIdForTarget

response

string

GUID/UUID of the target Connection in a Replication Services Solution. For other types of Solutions the Connection information is stored in an associated Map. See Maps.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

connectionName

response

string

User-specified name of a Connection used in one or more Maps in the Solution.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/connections

connectorID

response

string

GUID/UUID of the Connector for a Connection used in one or more Maps in the Solution.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/connections

connectorLogoUrl

response

string

URL where the logo for the Connector is stored.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/connections

connectorName

response

string

Displays the name of the Connector, such as Eloqua, Microsoft SQL Server, or Microsoft Dynamics GP, for a Connection used in one or more Maps in the Solution. See Connections in the TIBCO Scribe® Help for a complete list.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/connections

creationDate

response

string

Date and time in UTC time that the asynchronous Solution clone command was sent.

Date and time in UTC time that the prepare command was sent.

Date and time in UTC time that the Solution was created. This date is returned in the Solution model, but is not required when creating or modifying a Solution. It is updated or created automatically as needed.

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

dateTime

response

string

Date and time in UTC time that the Solution is scheduled to execute.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule

days

response

string

When setting a recurring schedule for a Solution, this field contains a set of options selected for the days the Solution executes. See the recurringOptions model for the Recurring scheduleOption. Fields include: 

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

daysIntervalStartDate

response

string

Used to set a recurring schedule for a Solution. When the daysOption is set to DaysInterval, this field indicates the start date for the first execution of a Solution. The daysInterval field is used to count from the date of execution to determine the date of the next execution of the Solution.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

daysInterval

response

integer

Used to set a recurring schedule for a Solution. When the daysOption is set to DaysInterval, this field indicates the number of days between one execution of a Solution and the next.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

daysOfMonth

response

array/integer

Used to set a recurring schedule for a Solution. When the daysOption is set to DaysOfMonth, this field lists the specific days of the month during which the Solution should execute.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

daysOfWeek

response

array/string

Used to set a recurring schedule for a Solution. When the daysOption is set to DaysOfWeek, this field lists the specific days of the week during which the Solution should execute.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

daysOption

response

string

When setting a recurring schedule for a Solution, this field indicates the option selected for the days the Solution executes. Options include: 

  • DaysInterval — Solution executes every X number of days.
  • DaysOfWeek — Solution executes on the days specified, such as Monday, Wednesday, and Friday.
  • DaysOfMonth — Solution executes on the days of the month specified, such as 1, 11, and 21.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

description

response

string

User-specified description for the Solution.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

entities

response

array

List of entities to be included in the next execution of this Replication Services Solution included in the RSEntitySelection model. 

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

hasError

response

boolean

Indicates whether or not the Solution has any errors.

  • true — Solution has errors.
  • false — Solution does not have errors.
  • POST /v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync
  • GET /v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync​/{cloneId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/prepare/{prepareId}

hourlyMinutes

response

integer

When setting a recurring schedule for a Solution with the timeOption set to TimeOfDay, this field indicates the number of minutes past the hour that the Solution should execute.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

id

response

string

GUID/UUID of the Object. Objects include:

  • Solutions
  • Clone job for a Solution
  • Prepare job for a Solution
  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/cloneAsync
  • GET /v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync​/{cloneId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/prepare/{prepareId}

inProgressStartTime

response

string

Date/Time when a Solution that is currently running started.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

isComplete

response

boolean

Indicates whether the asynchronous clone or the prepare process for a Solution is complete. See Copy Or Clone A Solution To Another Organization or Preparing a Solution.

  • true — Process is complete
  • false — Process is not complete.
  • POST /v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync​
  • GET /v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync​/{cloneId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/prepare/{prepareId}

isDisabled

response

boolean

Indicates whether or not the Solution is disabled.

  • true — Solution is disabled.
  • false — Solution is enabled.
  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

lastDayOfMonth

response

boolean

Used to set a recurring schedule for a Solution. When the daysOption is set to DaysOfMonth, this field indicates whether or not the Solution should execute on the last day of the month.

  • true — Execute Solution on the last day of the month.
  • false — Do not execute Solution on the last day of the month.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

lastModificationDate

response

string

Date and time in UTC time of the last time the Solution was modified.

This date is returned in the Solution model, but is not required when creating or modifying a Solution. It is updated or created automatically as needed.

  • GET /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}

lastRunTime

response

string

Date and time in UTC time of the last time the Solution ran.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

mapErrorModels

response

array

Array of Maps with errors in the Solution being prepared. See Preparing a Solution. Message field within this model may include the text of the error, or the top level message field may contain the error. Fields include: 

  • POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/prepare/{prepareId}

mapId

response

integer

ID of the Map with errors in the Solution being prepared. See Preparing a Solution.

  • POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/prepare/{prepareId}

mapLinks

response

string

One or more MapLinkModels included in the Solution. See Maps for individual field definitions.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

mapName

response

string

Name of the Map with errors in the Solution being prepared. This field is part of the mapErrorModels. See Preparing a Solution.

  • POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare

message

response

string

Status message returned by the asynchronous clone or the prepare Solution process, such as, Starting Preparation or the text for an error. See Copy Or Clone A Solution To Another Organization, Copy Or Clone A Solution Using Shared Resources, or Preparing a Solution.

Error message included in mapErrorModels for Maps with errors.

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

minAgentVersion

response

string

Minimum Agent version required to execute this Solution. 

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

modificationBy

response

string

Last user to modify the Solution. When set to Cloud this indicates that TIBCO Scribe® itself modified the Solution last, such as to update the Solution status.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

name

response

string

User-specified name of the Solution. Must be unique. If a duplicate name is used, TIBCO Scribe® appends a space and a number to make the duplicate unique.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

nextRunTime

response

string

Date and time in UTC time of the next time the Solution is scheduled to execute.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

reasonDisabled

response

integer

Indicates why a Solution is disabled, such as by the user or by the system when a TIBCO Scribe® Subscription ends.

  • 0 — Not disabled.
  • 1 — Disabled by user.
  • 2 — Cloud Agent unavailable.
  • 10 — Subscription has expired.
  • 11 — Maximum number of Solutions exceeded. Trial subscriptions have a limit of three Solutions.
  • 12 — Disabled by the system.
  • 21 — Subscription has expired and Solution was disabled by user.
  • 22 — Subscription has expired and Cloud Agent is unavailable.
  • 23 — Subscription has expired and the maximum number of Solutions was exceeded.
  • 24 — Subscription has expired and Solution was disabled by the system.
  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

recurringOptions

response

string

Model for the Recurring scheduleOption. Fields include: 

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

replicationSettings

response

array

Settings that are specific only to Replication Services Solutions.

  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

runOnceOptions

response

string

Model for the RunOnce scheduleOption. Fields include: 

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

scheduleOption

response

string

Type of execution schedule configured for the Solution. Options include:

  • OnDemand — Runs when triggered manually by the User.
  • RunOnce — Runs at a User-specified date and time.
  • Recurring — Runs at User-specified recurring intervals.

See Scheduling A Solution in the TIBCO Scribe® Help.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

selectionType

response

string

Indicates which entity selection option is configured for a Replication Services Solution in the RSEntitySelection model.

  • All — All available entities
  • Recommended — Only TIBCO Scribe® recommended entities
  • Selected — Only those entities selected by the user when configuring the RS Solution.
  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

solutionAgentType

response

string

Indicates which type of Agent is configured for the Solution. Types include: 

  • OnPremise — On-Premise Agent installed on your machine.
  • Cloud — Agent running in the TIBCO Scribe® Cloud.
  • None — No Agent selected.
  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

solutionCloneType

response

string

Solutions can be copied with the byReference parameter enabled or disabled. If enabled, source and target Solutions share resources and cannot be edited. Values for this parameter indicate the Solution type. See Copy Or Clone A Solution Using Shared Resources. Types include:

  • 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.
  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone
  • POST /v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync

solutionId

response

string

GUID/UUID of the Solution being cloned or prepared. See Copy Or Clone A Solution To Another Organization, Copy Or Clone A Solution Using Shared Resources, or Preparing a Solution.

  • POST /v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync​
  • GET /v1​/orgs​/{orgId}​/solutions​/{solutionId}​/cloneAsync​/{cloneId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/prepare
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/prepare/{prepareId}
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

solutionType

response

string

Type of Solution, includes: 

  • Replication — RS Solutions copy data from one data source to another. You can replicate all entities, recommended entities, or selected entities.
  • Integration — Scheduled IS Solutions integrate data from one data source into one or more target data sources on a user-specified schedule. IS Solutions use Maps, filters, and formulas to manipulate data as it moves from one data source to another.
  • IntegrationEvent — Event IS Solutions integrate data from one data source into another when an outside event triggers the Solution to execute.
  • Migration — MS Solutions are used for a one time migration of data from one datastore to another.
  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

status

response

string

Solution's current status. Options include: 

  • AgentHeartbeatFailed — Agent failed to contact TIBCO Scribe®.
  • AgentHeartbeatLate — Agent failed to contact TIBCO Scribe®.
  • AgentShutdown — On-Premise Agent has been shut down and has successfully contacted TIBCO Scribe® to communicate the shutdown.
  • AgentUpdating — Agent is updating to a new version.
  • Disabled — Solution is disabled.
  • Idle — Solution is scheduled to execute but is not running.
  • IdleLastRunFailed — The last execution of the scheduled Solution failed.
  • IdleLastRunRowErrors — The last execution of the scheduled Solution had errors.
  • Incomplete — Solution configuration is incomplete.
  • InProgress — Solution is running.
  • Obsolete, install new Agent — Agent and installed Connectors cannot be automatically updated because the version of the installed Agent is too old. Install a new Agent manually and edit your Solutions to use that Agent.
  • OnDemand — Solution must be executed manually.
  • OnDemandLastRunFailed — The last execution of the manually run Solution failed.
  • OnDemandLastRunRowErrors — The last execution of the manually run Solution had errors.
  • Preparing — Solution compiling and saving.
  • Provisioning — Provisioning a Cloud Agent.
  • ProvisionError — An error occurred while attempting to provision a Cloud Agent.
  • Restarting — Agent is restarting.
  • Starting — Solution execution has started.
  • Stopping — Solution execution is stopping.
  • UpdatingConnector — Agent is installing Connector updates.
  • WaitingForEvent — IS Event Solution is waiting for an event to trigger execution.
  • WaitingToRestartAgentMemoryLimitTIBCO 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.
  • WaitingToRestartAgentUserRequest — 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. See Restarting An On-Premise Agent in the TIBCO Scribe® Help.
  • WaitingToUpdateAgent — 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 UpdatingAgent status.
  • WaitingToUpdateConnector — 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 UpdatingConnector status.
  • GET /v1/orgs/{orgId}/solutions
  • POST /v1/orgs/{orgId}/solutions
  • GET /v1/orgs/{orgId}/solutions/{solutionId}
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}
  • POST /v1/orgs/{orgId}/solutions/{solutionId}/clone

timeInterval

response

integer

When setting a recurring schedule for a Solution with the timeOption set to TimeInterval, this field indicates the specific number of minutes or hours between Solution executions.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

timeIntervalUnit

response

string

When setting a recurring schedule for a Solution with the timeOption set to TimeInterval, this field indicates the units of measurement for the interval selected in the timeInterval field. Options include: None, Minutes, Hours.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

timeOfDay

response

string

When setting a recurring schedule for a Solution with the timeOption set to TimeOfDay, this field indicates the specific time that the Solution should execute.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

timeOption

response

string

When setting a recurring schedule for a Solution, this field indicates the option selected for the time of day the Solution executes. Options include: 

  • TimeOfDay — Solution executes at a specific time of day for the days selected in the days field.
  • HourlyMinutes — Solution executes every hour at X minutes past the hour. The number of minutes is set in the hourlyMinutes field.
  • TimeInterval — Solution executes at a set interval, such as every 15 minutes or every 12 hours.
  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

times

response

string

When setting a recurring schedule for a Solution, this field contains a set of options selected for the times of day the Solution executes. See the recurringOptions model for the Recurring scheduleOption. Fields include:

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

timeZone

response

string

When setting a recurring schedule for a Solution, this field indicates the Time Zone used for the Solution execution times. See Solution Schedule RecurringModel Timezone.

  • GET /v1/orgs/{orgId}/solutions/{solutionId}/schedule
  • PUT /v1/orgs/{orgId}/solutions/{solutionId}/schedule

 

See

Endpoints

API Basics