Citizen Platform Experience API

Get Organizations By Organizationid Flows getOrganizationsByOrganizationidFlows

GET

Try it out

Path Parameters

organizationId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Gets the authenticated user Flows.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

*/*

User flows with pagination.

pagination *: object

result: array

Examples

*/*

{ "pagination": { "page": 1, "size": 10 }, "results": [ { "id": "1f0e83c8-f2e3-43a4-864f-64a41882ec92", "name": "Citizen Integration", "owner": { "id": null, "name": "meli", "organizationId": "d1428a95-c05d-4c18-9010-c699db28af50" }, "description": null, "status": "running", "createdDate": "2020-04-10T03:15:46", "lastUpdatedDate": "2020-04-10T03:15:46" }, { "id": "d9284c62-f20b-4bca-91e9-30d25415623d", "name": "Flow example", "owner": { "id": null, "name": "meli", "organizationId": "d1428a95-c05d-4c18-9010-c699db28af50" }, "description": "Testing Citizen", "status": "running", "createdDate": "2020-04-10T03:15:46", "lastUpdatedDate": "2020-04-09T03:19:14" } ] }

Create Organizations By Organizationid Flows createOrganizationsByOrganizationidFlows

POST

Try it out

Path Parameters

organizationId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Creates a new flow.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

*/*

User flow was successfully created.

flowId *: string

Examples

*/*

{ "flowId": "476db727-a3ac-44bb-9d18-1720c72cb566" }

Please insert valid values.

Unauthorized user.

Duplicated flow name.

Get Organizations By Organizationid Flows By Flowid getOrganizationsByOrganizationidFlowsByFlowid

GET

Try it out

Path Parameters

organizationId *

flowId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Retrieves a flow.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

*/*

User flow was successfully retrieved.

id: string

name *: string

description: string

trigger: object

steps: array

createdDate *: string

lastUpdatedDate *: string

connectors: array

connectionIds: array

Examples

*/*

{ "id": "787f43a8-18ee-4ede-a048-0bb2c74db285", "name": "Citizen Integration Test", "description": "Listen new salesforce connections and create a new one.", "type": "citizenbuilder", "connectors": [ "salesforce" ], "trigger": { "index": 0, "id": "fc7f54f8-11de-4789-93dd-ab5b2bbc25e7", "name": "onNewRecord", "type": "TRIGGER", "connector": "Salesforce", "connectionId": "0e5aaf64-5143-4e46-a5c3-3f06c59d71c5", "fieldValues": { "fields": "LastName,FirstName,AccountId", "objectType": "Contact" }, "dynamicResults": [ { "name": "LastName", "label": "Last Name", "type": "STRING", "componentType": "TEXT" }, { "name": "FirstName", "label": "First Name", "type": "STRING", "componentType": "TEXT" }, { "name": "AccountId", "label": "Account Id", "type": "STRING", "componentType": "TEXT" } ] }, "steps": [ { "index": 1, "id": "1578712e-f1ef-4b13-ab80-d0368dee78ca", "name": "createRecord", "type": "ACTION", "connector": "Salesforce", "connectionId": "99372ea9-17dc-49c3-8a88-d76cb275719f", "fieldValues": { "LastName": "#[dataPill(salesforce.0.LastName)]", "FirstName": "#[dataPill(salesforce.0.FirstName)]", "AccountId": "#[dataPill(salesforce.0.AccountId)]", "objectType": "Contact" }, "dynamicFields": { "AccountId": { "name": "AccountId", "label": "Account Id", "type": "STRING", "required": false, "visible": false, "componentType": "TEXT", "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false }, "LastName": { "name": "LastName", "label": "Last Name", "type": "STRING", "required": true, "visible": true, "componentType": "TEXT", "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false }, "FirstName": { "name": "FirstName", "label": "Last Name", "type": "STRING", "required": false, "visible": false, "componentType": "TEXT", "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false }, "Salutation": { "name": "Salutation", "label": "Salutation", "type": "STRING", "required": false, "visible": true, "componentType": "SELECT", "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false, "dataProvider": { "options": [ { "value": "Mr.", "label": "Mr." }, { "value": "Ms", "label": "Ms." }, { "value": "Mrs.", "label": "Mrs." }, { "value": "Dr.", "label": "Dr." }, { "value": "Prof.", "label": "Prof." } ] } } }, "dynamicResults": [ { "name": "LastName", "label": "Last Name", "type": "STRING", "componentType": "TEXT" }, { "name": "FirstName", "label": "First Name", "type": "STRING", "componentType": "TEXT" }, { "name": "AccountId", "label": "Account Id", "type": "STRING", "componentType": "TEXT" } ] } ], "createdDate": "2020-05-18T09:22:19.297000+00:00", "lastUpdatedDate": "2020-05-18T09:22:19.297000+00:00" }

Update Organizations By Organizationid Flows By Flowid updateOrganizationsByOrganizationidFlowsByFlowid

PUT

Try it out

Path Parameters

organizationId *

flowId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Request Body application/json

Save changes in a flow.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Request Body

json

changeDetail: object

flow: object

Response

*/*

User flow was successfully saved.

change_detail: object

application_data: object

Examples

*/*

{ "changeDetail": { "message": "a message" }, "flow": { "id": "787f43a8-18ee-4ede-a048-0bb2c74db285", "name": "Citizen Integration Test", "description": "Listen new salesforce connections and create a new one.", "type": "citizenbuilder", "connectors": [ "salesforce" ], "trigger": { "index": 0, "id": "fc7f54f8-11de-4789-93dd-ab5b2bbc25e7", "name": "onNewRecord", "type": "TRIGGER", "connector": "Salesforce", "connectionId": "0e5aaf64-5143-4e46-a5c3-3f06c59d71c5", "fieldValues": { "fields": "LastName,FirstName,AccountId", "objectType": "Contact" }, "dynamicResults": [ { "name": "LastName", "label": "Last Name", "type": "STRING", "componentType": "TEXT" }, { "name": "FirstName", "label": "First Name", "type": "STRING", "componentType": "TEXT" }, { "name": "AccountId", "label": "Account Id", "type": "STRING", "componentType": "TEXT" } ] }, "steps": [ { "index": 1, "id": "1578712e-f1ef-4b13-ab80-d0368dee78ca", "name": "createRecord", "type": "ACTION", "connector": "Salesforce", "connectionId": "99372ea9-17dc-49c3-8a88-d76cb275719f", "fieldValues": { "LastName": "#[dataPill(salesforce.0.LastName)]", "FirstName": "#[dataPill(salesforce.0.FirstName)]", "AccountId": "#[dataPill(salesforce.0.AccountId)]", "objectType": "Contact" }, "dynamicFields": { "AccountId": { "name": "AccountId", "label": "Account Id", "type": "STRING", "required": false, "visible": false, "componentType": "TEXT", "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false }, "LastName": { "name": "LastName", "label": "Last Name", "type": "STRING", "required": true, "visible": true, "componentType": "TEXT", "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false }, "FirstName": { "name": "FirstName", "label": "Last Name", "type": "STRING", "required": false, "visible": false, "componentType": "TEXT", "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false }, "Salutation": { "name": "Salutation", "label": "Salutation", "type": "STRING", "required": false, "visible": true, "componentType": "SELECT", "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false, "dataProvider": { "options": [ { "value": "Mr.", "label": "Mr." }, { "value": "Ms", "label": "Ms." }, { "value": "Mrs.", "label": "Mrs." }, { "value": "Dr.", "label": "Dr." }, { "value": "Prof.", "label": "Prof." } ] } } }, "dynamicResults": [ { "name": "LastName", "label": "Last Name", "type": "STRING", "componentType": "TEXT" }, { "name": "FirstName", "label": "First Name", "type": "STRING", "componentType": "TEXT" }, { "name": "AccountId", "label": "Account Id", "type": "STRING", "componentType": "TEXT" } ] } ], "createdDate": "2020-05-18T09:22:19.297000+00:00", "lastUpdatedDate": "2020-05-18T09:22:19.297000+00:00" } }

Please input a valid flow ID.

You are not the owner of this flow.

Flow not found.

Delete Organizations By Organizationid Flows By Flowid deleteOrganizationsByOrganizationidFlowsByFlowid

DELETE

Try it out

Path Parameters

organizationId *

flowId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Deletes a flow

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

User flow was successfully deleted.

Create Organizations By Organizationid Flows By Flowid Clone createOrganizationsByOrganizationidFlowsByFlowidClone

POST

Try it out

Path Parameters

organizationId *

flowId *

Custom Query Parameters

Custom Headers

Request Body application/json

Clones a Flow with the same content as the previous flow

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Request Body

json

Response

*/*

Flow was cloned successfully

flowId *: string

Examples

*/*

{ "flowId": "476db727-a3ac-44bb-9d18-1720c72cb566" }

Create Organizations By Organizationid Flows By Flowid Execute createOrganizationsByOrganizationidFlowsByFlowidExecute

POST

Try it out

Path Parameters

organizationId *

flowId *

Custom Query Parameters

Custom Headers

Request Body application/json

Leaves a flow running.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Request Body

json

Response

Flow execution is being started.

Examples

*/*

{ "timestamp": "2020-10-15T04:14:26.702000+00:00", "path": "/api/v1/organizations/5fd5e1b9-02cf-44ec-9fb2-3cc17974df9f/flows/845100d0-eac0-4746-8da3-709f12d0b6b6/execute", "method": "POST", "response": 202, "description": "Flow execution started" }

Flow not found.

Flow already running or it is being started/stopped.

Create Organizations By Organizationid Flows By Flowid Stop createOrganizationsByOrganizationidFlowsByFlowidStop

POST

Try it out

Path Parameters

organizationId *

flowId *

Custom Query Parameters

Custom Headers

Request Body application/json

Stops the execution of a given flow.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Request Body

json

Response

Flow is being stopped.

Examples

*/*

{ "timestamp": "2020-10-15T04:14:26.702000+00:00", "path": "/api/v1/organizations/5fd5e1b9-02cf-44ec-9fb2-3cc17974df9f/flows/845100d0-eac0-4746-8da3-709f12d0b6b6/stop", "method": "POST", "response": 202, "description": "Flow being stopped" }

Flow not found.

Flow is not running or it is being stopped.

Get Organizations By Organizationid Flows By Flowid Status getOrganizationsByOrganizationidFlowsByFlowidStatus

GET

Try it out

Path Parameters

organizationId *

flowId *

Custom Query Parameters

Custom Headers

Returns the status of a given flow.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Response

*/*

Flow's status was successfully obtained.

status: string

timestamp: string

path: string

method: string

response: integer

description: string

Examples

*/*

{ "status": "STOPPED", "timestamp": "2020-10-15T04:24:30.732000+00:00", "path": "/api/v1/organizations/5fd5e1b9-02cf-44ec-9fb2-3cc17974df9f/flows/845100d0-eac0-4746-8da3-709f12d0b6b6/status", "method": "GET", "response": 200, "description": "Status available" }

Create Organizations By Organizationid Flows By Flowid Test createOrganizationsByOrganizationidFlowsByFlowidTest

POST

Try it out

Path Parameters

organizationId *

flowId *

Header Parameters

Access-Control-Allow-Origin *

X-Session-Id *

Custom Query Parameters

Custom Headers

Request Body application/json

Starts a test for a flow.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

X-Session-Id *: string

The X Session ID header value.

default: *

Request Body

json

Response

Test successfully started.

Examples

*/*

{ "timestamp": "2020-08-10T12:51:17.789000+00:00", "path": "/api/v1/organizations/10eb6323-4267-45bf-a1c2-ac745f73cf9a/design/test", "method": "POST", "description": "Flow test started" }

Bad request.

Unauthorized.

Flow does not exists.

Flow already running.

Delete Organizations By Organizationid Flows By Flowid Test deleteOrganizationsByOrganizationidFlowsByFlowidTest

DELETE

Try it out

Path Parameters

organizationId *

flowId *

Header Parameters

Access-Control-Allow-Origin *

X-Session-Id *

Custom Query Parameters

Custom Headers

Stops a test for a flow.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

X-Session-Id *: string

The X Session ID header value.

default: *

Response

Test successfully stopped.

Bad request.

Unauthorized.

Flow does not exists.

Flow not running.

Get Organizations By Organizationid Flows By Flowid Test Status getOrganizationsByOrganizationidFlowsByFlowidTestStatus

GET

Try it out

Path Parameters

organizationId *

flowId *

Header Parameters

Access-Control-Allow-Origin *

X-Session-Id *

Custom Query Parameters

Custom Headers

Returns the status of a flow test.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

X-Session-Id *: string

The X Session ID header value.

default: *

Response

Flow test status successfully retrieved.

Examples

*/*

{ "testStatus": "PENDING", "creationTime": 1598457303376, "message": "Why it is working, or failed" }

Bad request.

Unauthorized.

Flow does not exist.

Quota Limit reached for concurrent Design Operations.

Get Organizations By Organizationid Flows By Flowid Test Messages getOrganizationsByOrganizationidFlowsByFlowidTestMessages

GET

Try it out

Path Parameters

organizationId *

flowId *

Header Parameters

Access-Control-Allow-Origin *

X-Session-Id *

Custom Query Parameters

Custom Headers

Returns the messages of a flow test.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

flowId *: string

Identifies the flow to be opened.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

X-Session-Id *: string

The X Session ID header value.

default: *

Response

Flow test messages successfully retrieved.

Examples

*/*

{ "messages": [ { "cardId": "13123-123123-123123", "inputMessage": { "message": "Input message for cardId 13123-123123-123123", "createdDate": 1598457303376, "error": false }, "outputMessage": {} }, { "cardId": "456567-6567567-567555", "inputMessage": { "message": "Input message for cardId 456567-6567567-567555", "createdDate": 1598457303376, "error": false }, "outputMessage": { "message": "Error message for cardID 456567-6567567-567555", "createdDate": 1598457303376, "error": true } } ] }

Bad request.

Unauthorized.

Flow does not exist.

Quota Limit reached for concurrent Design Operations.

Get Organizations By Organizationid Connectors getOrganizationsByOrganizationidConnectors

GET

Try it out

Path Parameters

organizationId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Returns all the connectors available for the current user.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

*/*

Connectors were successfully obtained.

items: array

Array items

Examples

*/*

[ { "name": "salesforce", "label": "Salesforce", "description": "Provides integration with Salesforce", "iconUrl": "https://exchange2-asset-manager-kprod.s3.amazonaws.com/com.mulesoft.connectors/2bbb4ef0b7bde3f559df8c885833c4dcc0c53c5de7d6712853d77afc586f67d0.svg", "hasConnection": "true", "hasTrigger": "true", "hasAction": "true" } ]

Get Organizations By Organizationid Connectors By Connectorname getOrganizationsByOrganizationidConnectorsByConnectorname

GET

Try it out

Path Parameters

organizationId *

connectorName *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Retrieves a connectors.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectorName *: string

Name of the connectors whose citizen model will be returned

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

Citizen model successfully obtained.

Examples

*/*

{ "name": "salesforce", "label": "Salesforce", "description": "Some description", "dataProviders": [ { "name": "getObjectTypes" }, { "name": "getObjectTypeFields", "parameters": [ "objectType" ] } ], "triggers": [ { "name": "onNewRecord", "label": "On new record", "description": "Some description", "fields": [ { "name": "objectType", "label": "Object Type", "description": "Some description", "type": "STRING", "required": true, "visible": true, "componentType": "SELECT", "supportsExpression": false, "changesDynamicInput": false, "changesDynamicOutput": true, "dataProvider": { "name": "getObjectTypes" }, "affects": [ "fields" ], "affectedBy": [] }, { "name": "fields", "label": "Result fields", "description": "Filters the record fields to be returned. All fields are returned by default", "type": "ARRAY", "itemType": "STRING", "required": false, "visible": true, "componentType": "RESULT_FILTER", "supportsExpression": false, "changesDynamicInput": false, "changesDynamicOutput": true, "dataProvider": { "name": "getObjectTypeFields" }, "affects": [], "affectedBy": [ "fields" ] } ], "hasDynamicOutput": true, "requiresConnection": true } ], "actions": [ { "hasDynamicFields": true, "name": "createRecord", "label": "Create a new record", "description": "Some description", "fields": [ { "name": "objectType", "label": "Object Type", "description": "Some description", "type": "STRING", "required": true, "visible": true, "componentType": "SELECT", "supportsExpression": false, "changesDynamicInput": true, "changesDynamicOutput": false, "dataProvider": { "name": "getObjectTypes" }, "affects": [], "affectedBy": [] }, { "name": "record", "label": "Record", "description": "Record to be added", "type": "OBJECT", "required": true, "visible": true, "componentType": "DYNAMIC_MAPPER", "supportsExpression": false, "changesDynamicInput": false, "changesDynamicOutput": false, "dataProvider": null, "affects": [], "affectedBy": [ "objectType" ] } ], "results": [ { "name": "id", "label": "Record ID", "description": "Identifies the created record", "type": "STRING", "componentType": "TEXT" } ], "hasDynamicOutput": false, "requiresConnection": true } ], "iconUrl": "some icon URL" }

Create Organizations By Organizationid Connectors By Connectorname Sample Data createOrganizationsByOrganizationidConnectorsByConnectornameSampleData

POST

Try it out

Path Parameters

organizationId *

connectorName *

Query Parameters

refresh

Header Parameters

Access-Control-Allow-Origin *

X-Session-Id *

Custom Query Parameters

Custom Headers

Request Body application/json

Returns the sample data for a connector.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectorName *: string

Name of the connectors whose citizen model will be returned

Query Parameters

refresh: boolean

Indicates if cache should be invalidated or not

default: False

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

X-Session-Id *: string

The X Session ID header value.

default: *

Request Body

json

Response

Metadata was successfully obtained.

Examples

*/*

{ "output": { "LastModifiedDate": "2020-02-10T21:12:22+00:00", "Languages__c": "English", "AccountId": "0016g00000C5JBrAAN", "Email": "rose@edge.com", "type": "Contact", "MobilePhone": "(512) 757-9340", "Name": "Rose Gonzalez", "Department": "Procurement", "CreatedById": "0056g000004PtecAAC", "PhotoUrl": "/services/images/photo/0036g00000AWbyJAAT", "IsDeleted": "false", "IsEmailBounced": "false", "Birthdate": "1968-01-23", "CleanStatus": "Pending", "LeadSource": "Trade Show", "CreatedDate": "2020-02-10T21:12:22+00:00", "Id": "0036g00000AWbyJAAT", "LastName": "Gonzalez", "MailingStreet": "313 Constitution Place\nAustin, TX 78767\nUSA", "Salutation": "Ms.", "Level__c": "Primary", "OwnerId": "0056g000004PtecAAC", "Phone": "(512) 757-6000", "FirstName": "Rose", "Title": "SVP, Procurement", "MailingAddress": { "street": "313 Constitution Place\nAustin, TX 78767\nUSA" }, "SystemModstamp": "2020-02-10T21:12:22+00:00", "Fax": "(512) 757-9000", "LastModifiedById": "0056g000004PtecAAC" }, "outputAttributes": { "LastModifiedDate": "2020-02-10T21:12:22+00:00", "Languages__c": "English", "AccountId": "0016g00000C5JBrAAN", "Email": "rose@edge.com", "type": "Contact", "MobilePhone": "(512) 757-9340", "Name": "Rose Gonzalez", "Department": "Procurement", "CreatedById": "0056g000004PtecAAC", "PhotoUrl": "/services/images/photo/0036g00000AWbyJAAT", "IsDeleted": "false", "IsEmailBounced": "false", "Birthdate": "1968-01-23", "CleanStatus": "Pending", "LeadSource": "Trade Show", "CreatedDate": "2020-02-10T21:12:22+00:00", "Id": "0036g00000AWbyJAAT", "LastName": "Gonzalez", "MailingStreet": "313 Constitution Place\nAustin, TX 78767\nUSA", "Salutation": "Ms.", "Level__c": "Primary", "OwnerId": "0056g000004PtecAAC", "Phone": "(512) 757-6000", "FirstName": "Rose", "Title": "SVP, Procurement", "MailingAddress": { "street": "313 Constitution Place\nAustin, TX 78767\nUSA" }, "SystemModstamp": "2020-02-10T21:12:22+00:00", "Fax": "(512) 757-9000", "LastModifiedById": "0056g000004PtecAAC" } }

Bad request.

Unauthorized.

Connection not found.

Quota Limit reached for concurrent Design Operations.

Create Organizations By Organizationid Connectors By Connectorname Entity Provider createOrganizationsByOrganizationidConnectorsByConnectornameEntityProvider

POST

Try it out

Path Parameters

organizationId *

connectorName *

Header Parameters

Access-Control-Allow-Origin *

X-Session-Id *

Custom Query Parameters

Custom Headers

Request Body application/json

Returns the entity provider data for a connector.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectorName *: string

Name of the connectors whose citizen model will be returned

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

X-Session-Id *: string

The X Session ID header value.

default: *

Request Body

json

Response

Entity provider was successfully obtained.

Examples

*/*

{ "Account": [ { "name": "Id", "label": "Id", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "IsDeleted", "label": "IsDeleted", "description": "", "type": "BOOLEAN", "itemType": null, "results": [] }, { "name": "MasterRecordId", "label": "MasterRecordId", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Name", "label": "Name", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Type", "label": "Type", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "ParentId", "label": "ParentId", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "BillingStreet", "label": "BillingStreet", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "BillingCity", "label": "BillingCity", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "BillingState", "label": "BillingState", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "BillingPostalCode", "label": "BillingPostalCode", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "BillingCountry", "label": "BillingCountry", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "BillingLatitude", "label": "BillingLatitude", "description": "", "type": "NUMBER", "itemType": null, "results": [] }, { "name": "BillingLongitude", "label": "BillingLongitude", "description": "", "type": "NUMBER", "itemType": null, "results": [] }, { "name": "BillingGeocodeAccuracy", "label": "BillingGeocodeAccuracy", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "BillingAddress", "label": "BillingAddress", "description": "", "type": "OBJECT", "itemType": null, "results": [ { "name": "city", "label": "city", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "country", "label": "country", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "countryCode", "label": "countryCode", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "latitude", "label": "latitude", "description": "", "type": "NUMBER", "itemType": null, "results": [] }, { "name": "longitude", "label": "longitude", "description": "", "type": "NUMBER", "itemType": null, "results": [] }, { "name": "postalCode", "label": "postalCode", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "state", "label": "state", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "stateCode", "label": "stateCode", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "street", "label": "street", "description": "", "type": "STRING", "itemType": null, "results": [] } ] }, { "name": "ShippingStreet", "label": "ShippingStreet", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "ShippingCity", "label": "ShippingCity", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "ShippingState", "label": "ShippingState", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "ShippingPostalCode", "label": "ShippingPostalCode", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "ShippingCountry", "label": "ShippingCountry", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "ShippingLatitude", "label": "ShippingLatitude", "description": "", "type": "NUMBER", "itemType": null, "results": [] }, { "name": "ShippingLongitude", "label": "ShippingLongitude", "description": "", "type": "NUMBER", "itemType": null, "results": [] }, { "name": "ShippingGeocodeAccuracy", "label": "ShippingGeocodeAccuracy", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "ShippingAddress", "label": "ShippingAddress", "description": "", "type": "OBJECT", "itemType": null, "results": [ { "name": "city", "label": "city", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "country", "label": "country", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "countryCode", "label": "countryCode", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "latitude", "label": "latitude", "description": "", "type": "NUMBER", "itemType": null, "results": [] }, { "name": "longitude", "label": "longitude", "description": "", "type": "NUMBER", "itemType": null, "results": [] }, { "name": "postalCode", "label": "postalCode", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "state", "label": "state", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "stateCode", "label": "stateCode", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "street", "label": "street", "description": "", "type": "STRING", "itemType": null, "results": [] } ] }, { "name": "Phone", "label": "Phone", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Fax", "label": "Fax", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "AccountNumber", "label": "AccountNumber", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Website", "label": "Website", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "PhotoUrl", "label": "PhotoUrl", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Sic", "label": "Sic", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Industry", "label": "Industry", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "AnnualRevenue", "label": "AnnualRevenue", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Ownership", "label": "Ownership", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "TickerSymbol", "label": "TickerSymbol", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Description", "label": "Description", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Rating", "label": "Rating", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Site", "label": "Site", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "OwnerId", "label": "OwnerId", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "CreatedDate", "label": "CreatedDate", "description": "", "type": "DATE_TIME", "itemType": null, "results": [] }, { "name": "CreatedById", "label": "CreatedById", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "LastModifiedDate", "label": "LastModifiedDate", "description": "", "type": "DATE_TIME", "itemType": null, "results": [] }, { "name": "LastModifiedById", "label": "LastModifiedById", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "SystemModstamp", "label": "SystemModstamp", "description": "", "type": "DATE_TIME", "itemType": null, "results": [] }, { "name": "LastActivityDate", "label": "LastActivityDate", "description": "", "type": "DATE", "itemType": null, "results": [] }, { "name": "LastViewedDate", "label": "LastViewedDate", "description": "", "type": "DATE_TIME", "itemType": null, "results": [] }, { "name": "LastReferencedDate", "label": "LastReferencedDate", "description": "", "type": "DATE_TIME", "itemType": null, "results": [] }, { "name": "Jigsaw", "label": "Jigsaw", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "JigsawCompanyId", "label": "JigsawCompanyId", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "CleanStatus", "label": "CleanStatus", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "AccountSource", "label": "AccountSource", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "DunsNumber", "label": "DunsNumber", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Tradestyle", "label": "Tradestyle", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "NaicsCode", "label": "NaicsCode", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "NaicsDesc", "label": "NaicsDesc", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "YearStarted", "label": "YearStarted", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "SicDesc", "label": "SicDesc", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "DandbCompanyId", "label": "DandbCompanyId", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "OperatingHoursId", "label": "OperatingHoursId", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "CustomerPriority__c", "label": "CustomerPriority__c", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "SLA__c", "label": "SLA__c", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "Active__c", "label": "Active__c", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "NumberofLocations__c", "label": "NumberofLocations__c", "description": "", "type": "NUMBER", "itemType": null, "results": [] }, { "name": "UpsellOpportunity__c", "label": "UpsellOpportunity__c", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "SLASerialNumber__c", "label": "SLASerialNumber__c", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "SLAExpirationDate__c", "label": "SLAExpirationDate__c", "description": "", "type": "DATE", "itemType": null, "results": [] }, { "name": "Great_Divide_Id__c", "label": "Great_Divide_Id__c", "description": "", "type": "STRING", "itemType": null, "results": [] }, { "name": "fieldsToNull", "label": "FieldsToNull", "description": "", "type": "ARRAY", "itemType": "STRING", "results": [] } ] }

Bad request.

Unauthorized.

Create Organizations By Organizationid Connectors By Connectorname Connections By Connectionid Value Resolver createOrganizationsByOrganizationidConnectorsByConnectornameConnectionsByConnectionidValueResolver

POST

Try it out

Path Parameters

organizationId *

connectorName *

connectionId *

Query Parameters

refresh

Header Parameters

Access-Control-Allow-Origin *

X-Session-Id *

Custom Query Parameters

Custom Headers

Request Body application/json

Returns the data from a data provider.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectorName *: string

Name of the connectors whose citizen model will be returned

connectionId *: string

The connection ID to identify the target resource.

Query Parameters

refresh: boolean

Indicates if cache should be invalidated or not

default: False

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

X-Session-Id *: string

The X Session ID header value.

default: *

Request Body

json

Response

Connectors data provider was successfully executed.

Examples

*/*

{ "results": [ { "value": "Account", "label": "Account" }, { "value": "Contact", "label": "Contact" }, { "value": "Lead", "label": "Lead" } ] }

Bad request.

Unauthorized.

Connection not found.

Quota Limit reached for concurrent Design Operations.

Create Organizations By Organizationid Connectors By Connectorname Connections By Connectionid Metadata createOrganizationsByOrganizationidConnectorsByConnectornameConnectionsByConnectionidMetadata

POST

Try it out

Path Parameters

organizationId *

connectorName *

connectionId *

Query Parameters

refresh

Header Parameters

Access-Control-Allow-Origin *

X-Session-Id *

Custom Query Parameters

Custom Headers

Request Body application/json

Returns the metadata for a connector.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectorName *: string

Name of the connectors whose citizen model will be returned

connectionId *: string

The connection ID to identify the target resource.

Query Parameters

refresh: boolean

Indicates if cache should be invalidated or not

default: False

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

X-Session-Id *: string

The X Session ID header value.

default: *

Request Body

json

Response

Metadata was successfully obtained.

Examples

*/*

{ "inputFields": { "record": [ { "name": "objectType", "label": "Object Type", "type": "STRING", "componentType": "TEXT", "description": "Object type input field description", "required": false, "visible": true, "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false, "dataProvider": {} }, { "name": "FirstName", "label": "First Name", "type": "STRING", "componentType": "TEXT", "description": "Contact first name", "required": false, "visible": true, "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false, "dataProvider": {} }, { "name": "AccountId", "label": "Account Id", "type": "STRING", "componentType": "TEXT", "description": "Id number for the account", "required": false, "visible": true, "supportsExpression": true, "changesDynamicInput": false, "changesDynamicOutput": false, "dataProvider": {} } ] }, "outputFields": [ { "name": "LastName", "label": "Last Name", "type": "STRING", "componentType": "TEXT", "description": "Contact Last name" }, { "name": "FirstName", "label": "First Name", "type": "STRING", "componentType": "TEXT", "description": "Contact First name" }, { "name": "AccountId", "label": "Account Id", "type": "STRING", "componentType": "TEXT", "description": "Id number for the account" }, { "name": "address", "label": "Address", "type": "OBJECT", "description": "Personal address", "fields": [ { "name": "street", "label": "Street", "type": "STRING", "componentType": "TEXT", "description": "Street name" }, { "name": "number", "label": "Number", "type": "STRING", "componentType": "TEXT", "description": "Address number" } ] } ] }

Bad request.

Unauthorized.

Connection not found.

Quota Limit reached for concurrent Design Operations.

Get Organizations By Organizationid Connection Schemas Connectors By Connectorname getOrganizationsByOrganizationidConnectionSchemasConnectorsByConnectorname

GET

Try it out

Path Parameters

organizationId *

connectorName *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Get all available connector connection schemas.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectorName *: string

The connectorName to identify the target resource.

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

Connection schemas were successfully obtained.

Examples

*/*

[ { "groupId": "com.mulesoft.schemas", "artifactId": "mule-salesforce-connector-platform-oauth", "version": "1.0", "schemaId": "ae3a114b-33d7-430f-bbac-629770ee1efe" } ]

Get Organizations By Organizationid Connections getOrganizationsByOrganizationidConnections

GET

Try it out

Path Parameters

organizationId *

Query Parameters

offset

limit

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Get all available connections.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

offset: integer

First ordered item that you want to retrieve

default: 0, min: 0

limit: integer

Maximum number of items returned

default: 100, min: 0

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

Connections were successfully obtained.

Examples

*/*

{ "total": 2, "data": [ { "id": "af759cc1-4e47-462d-ab27-f4ad700943fd3", "name": "My Salesforce connection 1", "connectorName": "salesforce", "labels": { "description": "This is my new Salesforce connection" }, "schema": { "id": "ae3a114b-33d7-430f-bbac-629770ee1efe", "labels": { "type": "PlatformManagedOAuthConnection", "system": "Salesforce", "connectionProvider": "platformManagedOauth", "serviceProviderName": "salesforce" } } }, { "id": "68b9cfa8-dc01-11ea-87d0-0242ac130003", "name": "My Salesforce connection 2", "connectorName": "salesforce", "schema": { "id": "ae3a114b-33d7-430f-bbac-629770ee1efe", "labels": { "type": "PlatformManagedOAuthConnection", "system": "Salesforce", "connectionProvider": "platformManagedOauth", "serviceProviderName": "salesforce" } } } ] }

Create Organizations By Organizationid Connections createOrganizationsByOrganizationidConnections

POST

Try it out

Path Parameters

organizationId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Creates a new non-OAuth connection. For starting OAuth dance, please use /ocs-connections.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

The connection was successfully created.

Examples

*/*

{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connector": { "type": "string" }, "connectionId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "connector", "connectionId", "name" ] }

Get Organizations By Organizationid Connections Connectors By Connectorname getOrganizationsByOrganizationidConnectionsConnectorsByConnectorname

GET

Try it out

Path Parameters

organizationId *

connectorName *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Retrieves a connectors.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectorName *: string

Identifies the connector name.

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

Connector connections were successfully obtained.

Examples

*/*

[ { "connectionId": "68b9cfa8-dc01-11ea-87d0-0242ac130003", "name": "My SFDC OAuth connection", "connectionSchema": { "schemaId": "76fc51e4-dc01-11ea-87d0-0242ac130003", "name": "salesforce-ocs-1.0" } }, { "connectionId": "70fa49fe-dc01-11ea-87d0-0242ac130003", "name": "My SFDC Basic connection", "connectionSchema": { "schemaId": "8a264824-dc01-11ea-87d0-0242ac130003", "name": "salesforce-basic-1.0" } } ]

Get Organizations By Organizationid Connections By Connectionid getOrganizationsByOrganizationidConnectionsByConnectionid

GET

Try it out

Path Parameters

organizationId *

connectionId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Retrive a single connection by ID.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectionId *: string

Identifies the connection.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidConnections.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

A connections was successfully obtained.

Examples

*/*

{ "connectionId": "68b9cfa8-dc01-11ea-87d0-0242ac130003", "name": "My SFDC OAuth connection", "connectionSchema": { "schemaId": "76fc51e4-dc01-11ea-87d0-0242ac130003", "name": "salesforce-ocs-1.0" } }

Patch Organizations By Organizationid Connections By Connectionid patchOrganizationsByOrganizationidConnectionsByConnectionid

PATCH

Try it out

Path Parameters

organizationId *

connectionId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Request Body application/json

Update a connection.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectionId *: string

Identifies the connection.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidConnections.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Request Body

json

Response

Connection was successfully updated.

Delete Organizations By Organizationid Connections By Connectionid deleteOrganizationsByOrganizationidConnectionsByConnectionid

DELETE

Try it out

Path Parameters

organizationId *

connectionId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Delete a connection.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectionId *: string

Identifies the connection.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidConnections.$.id

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

Delete success, no response content.

Unauthorized.

Quota Limit reached.

Create Organizations By Organizationid Connections By Connectionid Test createOrganizationsByOrganizationidConnectionsByConnectionidTest

POST

Try it out

Path Parameters

organizationId *

connectionId *

Header Parameters

x-session-id

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Request Body application/json

Test the connectivity of an existing connection.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

connectionId *: string

Identifies the connection.

Related Operations:

citizen-platform-experience#getOrganizationsByOrganizationidConnections.$.id

Header Parameters

x-session-id: string

Flow session ID.

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Request Body

json

Response

Test connectivity result was obtained (either successful or not).

Examples

*/*

{ "success": true, "errorInfo": {} }

Create Organizations By Organizationid Connections Test createOrganizationsByOrganizationidConnectionsTest

POST

Try it out

Path Parameters

organizationId *

Header Parameters

x-session-id

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Request Body application/json

Test the connectivity of a draft connection.

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Header Parameters

x-session-id: string

Flow session ID.

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Request Body

json

Response

Test connectivity result was obtained (either successful or not).

Examples

*/*

{ "success": true, "errorInfo": {} }

Create Organizations By Organizationid Ocs Connections createOrganizationsByOrganizationidOcsConnections

POST

Try it out

Path Parameters

organizationId *

Header Parameters

Access-Control-Allow-Origin *

Custom Query Parameters

Custom Headers

Starts the OAuth dance (OCS).

Path Parameters

organizationId *: string

Identifies the Master Organization Id of the user.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Header Parameters

Access-Control-Allow-Origin *: string

The Access Control Allow Origin header value.

default: *

Response

Successfully started the OAuth dance.

Examples

*/*

{ "location": "https://login.salesforce.com/..." }

Overview

Servers

Authentication & Security

Get Organizations By Organizationid Flows getOrganizationsByOrganizationidFlows

Try it out

Response

Path Parameters

Header Parameters

Response

Create Organizations By Organizationid Flows createOrganizationsByOrganizationidFlows

Try it out

Response

Path Parameters

Header Parameters

Response

Get Organizations By Organizationid Flows By Flowid getOrganizationsByOrganizationidFlowsByFlowid

Try it out

Response

Path Parameters

Header Parameters

Response

Update Organizations By Organizationid Flows By Flowid updateOrganizationsByOrganizationidFlowsByFlowid

Try it out

Response

Path Parameters

Header Parameters

Request Body

Response

Delete Organizations By Organizationid Flows By Flowid deleteOrganizationsByOrganizationidFlowsByFlowid

Try it out

Response

Path Parameters

Header Parameters

Response

Create Organizations By Organizationid Flows By Flowid Clone createOrganizationsByOrganizationidFlowsByFlowidClone

Try it out

Response

Path Parameters

Request Body

Response

Create Organizations By Organizationid Flows By Flowid Execute createOrganizationsByOrganizationidFlowsByFlowidExecute

Try it out

Response

Path Parameters

Request Body

Response

Create Organizations By Organizationid Flows By Flowid Stop createOrganizationsByOrganizationidFlowsByFlowidStop

Try it out

Response

Path Parameters

Request Body

Response

Get Organizations By Organizationid Flows By Flowid Status getOrganizationsByOrganizationidFlowsByFlowidStatus

Try it out

Response

Path Parameters

Response

Create Organizations By Organizationid Flows By Flowid Test createOrganizationsByOrganizationidFlowsByFlowidTest

Try it out

Response

Path Parameters

Header Parameters

Request Body

Response

Delete Organizations By Organizationid Flows By Flowid Test deleteOrganizationsByOrganizationidFlowsByFlowidTest

Try it out

Response

Path Parameters

Header Parameters

Response

Get Organizations By Organizationid Flows By Flowid Test Status getOrganizationsByOrganizationidFlowsByFlowidTestStatus

Try it out

Response

Path Parameters

Header Parameters

Response

Get Organizations By Organizationid Flows By Flowid Test Messages getOrganizationsByOrganizationidFlowsByFlowidTestMessages

Try it out

Response