Organizations

email

query

string

Email of the User. Used to modify or delete a User from an Organization. Required

endpointId

query

integer

ID of the Message Endpoint used to clear messages from the queue. Required

expandStatus

query

boolean

Includes the Organization status and cause. Default is false.

• true — Includes status.
• false — Does not include status.

filterbyAPIAccess

query

boolean

Filters the list of Organizations returned based on whether or not your IP address is included in the range of IP addresses with API access. Default is false.

• true — Returns only Organizations in which your IP address is configured for API access.
• false — Returns all Organizations.

See Setting Security Options in the TIBCO Scribe® Help.

limit

query

integer

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

Objects include:

• Organizations
• Message Endpoints
• Security Rules
• Users

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

model

body

model

Model of the Object. Required Objects include:

• Organizations
• Security Rules
• Security Settings
• Users

name

query

string

User-specified name of the Organization. Must be an exact match. Cannot be specified if the nameContains parameter is set.

nameContains

query

string

Filters for an Organization name that is a partial match. For example, if the Organization you want is Smith Industries, you can specify only Smith. You cannot specify Smithson.

Cannot be specified if the name parameter is set.

offset

query

integer

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

Objects include: 

• Organizations
• Message Endpoints
• Security Rules
• Users

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

noPagination

query

boolean

Ignores the offset and limit parameters. Returns all relevant Organizations without pagination. Default is false.

• true — Does not use pagination.
• false — Uses pagination.

orgId

query

integer

ID of the Organization.

If used to delete, only a Child Organization can be deleted.

parentId

query

integer

ID of a Parent Organization. Only returns Child Organizations for the selected Parent Organization.

ruleId

path

string

ID of a Security Rule. Required

status

query

string

Filter by Organization status. Options include:

• All — Returns all Organizations. Default.
• Ok — No issues.
• Processing — Busy processing Solutions.
• Job Disabled —A Solution has been disabled either manually or because the Subscription has expired.
• Job Warning — A Solution completed with record errors.
• Job Failure —A Solution execution failed with Fatal Errors.
• System Issue — Agent heartbeat late.
• System Failure — Agent is shutdown.

administrators

response

array

List of users who have an Administrator Role in the selected Organization. See Roles in the TIBCO Scribe® Help.

allowedIpRangeEndAddress

response

string

Last IP address in the range used to control access to the Organization's TIBCO Scribe® API and Endpoint URLs used for Event Solutions. Only those IP addresses in the configured range are granted access. Used in the OrganizationSecurityRuleModel. Required

allowedIpRangeStartAddress

response

string

First IP address in the range used to control access to the Organization's TIBCO Scribe® API and Endpoint URLs used for Event Solutions. Only those IP addresses in the configured range are granted access. Used in the OrganizationSecurityRuleModel. Required

apiAccessEnabled

response

boolean

Indicates whether this IP address range is granted access to manage the Organization via the API. If there is no IP address range with this field set to true, access via the API is denied for all Endpoints. Used in the OrganizationSecurityRuleModel.

• true — Access is enabled for IP addresses within this range.
• false — This range of IP addresses is not granted access to the API.

apiCryptoToken

response

string

GUID/UUID — Token used to encrypt or decrypt Connection properties when reading, creating, or modifying Connections using the TIBCO Scribe® API. See Connection Properties. See Setting Security Options in the TIBCO Scribe® Help.

apiToken

response

string

GUID/UUID — Token used to encrypt or decrypt Connection properties when reading, creating, or modifying Connections using the TIBCO Scribe® API. See Connection Properties.

blobValue

response

array

This field holds the value for the setting only when valueType = 2.

captureOnFailedRecordsForReprocessing

response

boolean

Enables/disables capturing any failed source records generated when a Solution runs. Applies to all Solutions in the Organization. Default setting is true. See the Storing Record Errors section of Setting Security Options in the TIBCO Scribe® Help.

• true — Store source data for record errors.
• false — Do not store source data for record errors.

captureDuringCloudAppRuns

response

boolean

Enables/disables capturing failed records for Solutions run by the Cloud Agent. Records are stored in the Cloud. Default setting is true. See the Storing Record Errors section of Setting Security Options in the TIBCO Scribe® Help.

• true — Store source data for record errors.
• false — Do not store source data for record errors.

captureDuringLocalAgentAppRuns

response

boolean

Enables/disables capturing failed records for Solutions run by the On-Premise Agent. Records are stored in the Cloud or on the server where the Agent is installed based on the isSourceDataLocal setting. Default setting is true. See the Storing Record Errors section of Setting Security Options in the TIBCO Scribe® Help.

• true — Store source data for record errors.
• false — Do not store source data for record errors in the cloud.

categoryName

response

string

Type of Function. Types include:

• Data Conversion — Convert values from one data type to another.
• DateTime — Retrieve, parse, and manage date and time values.
• Lookup — Find values in Lookup Tables and target entities.
• Math — Perform common mathematical operations on values.
• Miscellaneous — Find the Agent's computername and perform GUID operations.
• Text — Manipulate text values.

city

response

string

City address field for the company associated with this Organization.

country

response

string

Country address field for the company associated with this Organization.

createDateTime

response

string

Date and time in UTC time that the Message Endpoint was created.

dataCenterId

response

integer

ID of the Data Center where the Organization and associated Cloud Agents are hosted. If ID is omitted, the default Data Center is in the United States. Data center IDs include:

• 1=AWS US
• 2=AWS Europe
• 12=Azure US
• 13=AWS Australia
• 14=AWS US East

dataCenterName

response

string

Name of the Data Center where the Organization and associated Cloud Agents are hosted.

dataCenterLocation

response

string

Location of the Data Center where the Organization and associated Cloud Agents are hosted.

decimalValue

response

string

This field holds the value for the setting only when valueType = 1.

descriptionURL

response

string

URL for the html page with a description of the Function and corresponding examples. In the TIBCO Scribe® UI, these pages are used as embedded Help in the Formula Editor to assisted the user when a Function is selected.

email

response

string

Email address of the TIBCO Scribe® User.

entityName

response

string

Name of the entity configured in the Wait For Message Block in the Message Map. See Blocks.

eventSolutionAccessEnabled

response

boolean

Indicates whether or not this IP address range is granted access to Endpoint URLs for Event Solutions. Default is false. At least one Security Rule is required for Event Solutions. Used in the OrganizationSecurityRuleModel. See Setting Security Options in the TIBCO Scribe® Help.

• true — Access to Endpoint URLs for Event Solutions is enabled for this IP address range.
• false — Access to Endpoint URLs Event Solutions is disabled for this IP address range.

eventSolutionAccessToken

response

string

GUID/UUID — Token used to allow access to TIBCO Scribe® from outside sources for event driven Solutions. See Setting Security Options in the TIBCO Scribe® Help.

firstName

response

string

First name of the TIBCO Scribe® User.

id

response

integer

ID of the Object. Objects include: 

• Organizations
• Message Endpoints

id

response

string

GUID UUID of the set of Security Rules used in the OrganizationSecurityRuleModel.

ID of the Function from the list of Functions available to create Formulas in the Formula Editor. See Functions in the TIBCO Scribe® Help.

GUID UUID of the settings for this Organization.

isAgentLogDownloadAllowed

response

boolean

Returned as part of the model but no longer used. Is not required for PUT and POST operations. If used in a PUT or POST operation, changes are ignored.

In prior releases, indicated whether TIBCO Scribe® Support could retrieve Agent logs stored on the computer where the On-Premise Agent is installed. Default is true.

• true — Agent logs can be retrieved.
• false — Agent logs cannot be retrieved.

isSourceDataLocal

response

boolean

Enables/disables storing failed records locally for apps run by the On-Premise Agent. See the Storing Record Errors section of Setting Security Options in the TIBCO Scribe® Help.

• true — Store source data for record errors on the computer where the Agent is installed.
• false — Store source data for record errors in the cloud.

isTibcoOrg

response

boolean

Indicates whether or not the Organization is a TIBCO Cloud™ Integration Organization.

• true — Is a TIBCO Cloud™ Integration Organization.
• false — Is a TIBCO Scribe® Online Classic Organization.

lastModificationDate

response

string

Date and time in UTC time that the Function or Message Endpoint was last changed.

lastName

response

string

Last name of the TIBCO Scribe® User.

mapDescription

response

string

User-specified description of the Message Map.

mapName

response

string

Name of the Message Map.

messageCount

response

integer

Number of messages received by the Message Map.

name

response

string

User-specified name of the Object. Required. Objects include:

• Organizations
• Security Rules name used in the OrganizationSecurityRuleModel.
• Functions
• Security Rules
• Settings

parentId

response

integer

ID of the Parent Organization. If the Organization returned is not a Child Organization, this value is always 0. See Managing A Parent Organization and Managing Child Organizations in the TIBCO Scribe® Help.

pendingInvitation

response

boolean

Indicates whether or not the User has an invitation that has not been accepted. See Accepting Or Declining Invitations in the TIBCO Scribe® Help.

• true — User has a pending invitation.
• false — User does not have a pending invitation.

postalCode

response

string

Zip Code or Postal Code address field for the company associated with this Organization.

primaryContactCity

response

string

City address field for the primary contact for this Organization.

primaryContactCountry

response

string

Country address field for the primary contact for this Organization.

primaryContactEmail

response

string

Email address for the primary contact for this Organization.

primaryContactFirstName

response

string

First Name of the primary contact for this Organization. Primary contact is the Administrator who created the Organization.

primaryContactLastName

response

string

Last Name of the primary contact for this Organization.

primaryContactPhoneNumber

response

string

Telephone number for the primary contact for this Organization.

primaryContactPostalCode

response

string

Zip Code or Postal Code address field for the primary contact for this Organization.

primaryContactState

response

string

State address field for the primary contact for this Organization.

primaryContactStreet

response

string

Street address for the primary contact for this Organization

processDefinitionId

response

string

This field is not used.

prototype

response

string

Data type returned by this Function.

role

response

string

Role of the TIBCO Scribe® User. User roles control permissions. Roles include: 

• Administrator — Has full access to TIBCO Scribe®.
• User — Has access to everything except modifying Organization and User information.

See Managing Users in the TIBCO Scribe® Help.

securityRules

response

array

Access rules for the Organization. OrganizationSecurityRuleModel fields include: 

• apiAccessEnabled
• allowedIpRangeEndAddress
• allowedIpRangeStartAddress
• eventSolutionAccessEnabled
• id
• name

solutionId

response

string

The GUID / UUID of the Event Solution that contains the Message Map.

solutionName

response

string

Name of the Event Solution that contains the Message Map.

solutionStatusErrors

response

string

If you have selected an Organization Status filter when querying for Organizations, the associated Solution Status errors are included here. For example, if you filtered by System Failure, then Agent is shutdown is returned as the Solution Status error. See status for statuses and errors.

If no filter is selected, returns null.

state

response

string

State address field for the company associated with this Organization.

State of the Message Map returned in a list of Message Endpoints. States include:

• Incomplete
• Complete
• Disabled

status

response

string

Organization status filter used when requesting information about one or more Organizations.

• All — All Organizations. No filter selected.
• Ok — No issues.
• Processing — Busy processing Solutions.
• Job Disabled —A Solution has been disabled either manually or because the Subscription has expired.
• Job Warning — A Solution completed with record errors.
• Job Failure —A Solution execution failed with Fatal Errors.
• System Issue — Agent heartbeat late.
• System Failure — Agent is shutdown.

street

response

string

Street address field for the company associated with this Organization.

stringValue

response

string

Data or Value for the Setting configuration. For example, if the setting is Countries, this field contains the list of valid countries in the Organization. This field holds the value for the setting only when valueType = 0.

tenantRole

response

string

Role of the primary user associated with this Organization. See Roles in the TIBCO Scribe® Help. Options include:

• None
• User
• Administrator

tenantType

response

integer

Designates the type of Organization. Types include:

• 0 — Normal stand-alone Organization.
• 1 — Parent Organization.
• 2 — Child Organization.

url

response

string

URL of the Message Endpoint. Must be part of the Outbound Message configuration for the message Source, such as Salesforce. See Organization Information in the TIBCO Scribe® Help.

valueType

response

integer

Indicates the data type of the configured setting and the field in the model where the value is stored, as follows:

• If valueType = 0, the stringValue field holds the value for this setting.
• If valueType=1, the decimalValue field holds the value for this setting.
• If valueType=2, the blobValue field holds the value for this setting.