@gigya/destination
Version:
Gigya API Client with SAP Cloud SDK Destination Support
2,549 lines (2,548 loc) • 67.9 kB
JavaScript
const setAccountInfoRequestSchema = {
allOf: [
{
"$ref": "#/components/schemas/account"
}
]
};
const getAccountInfoResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/account_response"
},
{
"$ref": "#/components/schemas/account"
}
]
};
const profileSchema = {
type: "object",
properties: {
photoURL: {
type: ["string", "null"]
},
"certifications.number": {
type: ["string", "null"]
},
religion: {
type: ["string", "null"]
},
"likes.timestamp": {
type: ["number", "null"]
},
birthYear: {
type: ["number", "null"]
},
languages: {
type: ["string", "null"]
},
"work.startDate": {
type: ["string", "null"]
},
industry: {
type: ["string", "null"]
},
firstName: {
type: ["string", "null"]
},
city: {
type: ["string", "null"]
},
gender: {
format: "regex",
pattern: "('^[fmu]{1}$')",
type: ["string", "null"]
},
hometown: {
type: ["string", "null"]
},
zip: {
type: ["string", "null"]
}
}
};
const dataSchema = {
type: "object",
additionalProperties: true
};
const subscriptionsSchema = {
properties: {
email: {
additionalProperties: {
type: "object",
properties: {
isSubscribed: {
type: "boolean"
}
}
}
}
}
};
const preferencesSchema = {
additionalProperties: {
properties: {
isConsentGranted: {
type: "boolean"
}
}
}
};
const communicationSchema = {
type: "object",
"$id": "CommunicationModel",
"x-tags": ["communication"],
propertyNames: {
pattern: "(\\S+)(_)(sms+|email+)"
},
additionalProperties: {
type: "object",
properties: {
uid: {
description: "Represents the user who subscribed to thos topic",
type: "string"
},
channel: {
type: "string",
examples: ["sms", "email"]
},
timestamp: {
type: "integer",
description: "timestamp of the action",
readOnly: true
},
topic: {
description: "Represents a unique id of a communication list",
type: "string",
examples: ["newslatter", "special-offers"]
},
status: {
enum: ["opt-in", "opt-out", "notice"],
examples: ["opt-in", "opt-out", "notice"]
}
}
},
example: {
news_sms: {
topic: "news",
channel: "sms",
status: "opt-in",
timestamp: 567003434
},
news_email: {
topic: "news",
channel: "email",
status: "opt-out",
timestamp: 567003434
},
deals_email: {
topic: "deals",
channel: "email",
status: "noticed",
timestamp: 567003434
}
}
};
const accountSchema = {
"$id": "account",
title: "Account Object",
description: "The Account Object",
type: "object",
properties: {
profile: {
"$ref": "#/components/schemas/profile"
},
data: {
"$ref": "#/components/schemas/data"
},
subscriptions: {
"$ref": "#/components/schemas/subscriptions"
},
preferences: {
"$ref": "#/components/schemas/preferences"
},
communication: {
"$ref": "#/components/schemas/communication"
}
}
};
const basic_responseSchema = {
"x-tags": ["basic_response"],
type: "object",
required: ["callId", "errorCode", "time"],
properties: {
errorCode: {
type: "integer",
readOnly: true
},
callId: {
type: "string",
readOnly: true
},
time: {
type: "string",
format: "date-time"
},
statusCode: {
type: "integer",
minimum: 200,
maximum: 599
},
apiVersion: {
type: "integer",
const: 2
}
},
additionalProperties: true
};
const ok_responseSchema = {
"x-tags": ["ok_response"],
type: "object",
required: ["callId", "errorCode", "time"],
allOf: [
{
"$ref": "#/components/schemas/basic_response"
}
],
properties: {
errorCode: {
type: "integer",
minimum: 200,
maximum: 299
},
statusCode: {
type: "integer",
minimum: 200,
maximum: 399
}
}
};
const account_responseSchema = {
"x-tags": ["account_response"],
type: "object",
allOf: [
{
"$ref": "#/components/schemas/ok_response"
},
{
properties: {
UID: {
type: "string",
description: "User external Id"
}
}
}
]
};
const error_responseSchema = {
"x-tags": ["error_response"],
type: "object",
required: ["errorCode", "errorMessage", "errorDetails"],
allOf: [
{
"$ref": "#/components/schemas/basic_response"
}
],
properties: {
errorMessage: {
type: "string"
},
errorCode: {
type: "integer",
minimum: 4e5,
maximum: 599999
},
errorDetails: {
type: "string"
},
statusCode: {
type: "integer",
minimum: 400,
maximum: 599
}
}
};
const DqmCredentialsResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ok_response"
},
{
"$ref": "#/components/schemas/DqmCredentials"
}
]
};
const DqmCredentialsSchema = {
type: "object",
properties: {
clientId: {
type: "string"
},
clientSecret: {
type: "string"
},
tokenUrl: {
type: "string"
},
applicationUrl: {
type: "string"
}
}
};
const B2BSearchResponseSchema = {
description: "Search Organization Response",
allOf: [
{
"$ref": "#/components/schemas/B2BOrganization"
},
{
"$ref": "#/components/schemas/ok_response"
}
]
};
const B2BOrganizationSchema = {
properties: {
lastUpdated: {
type: "string",
example: "2022-12-08T14:05:09.221Z"
},
lastUpdatedTimestamp: {
type: "number",
example: 1670508309221
},
orgId: {
type: "string",
example: "70e2a7f5-32c7-4382-a2c7-ab697eab3eba",
description: "The organization's orgId"
},
orgName: {
type: "string",
example: "file-org1",
description: "The organization name"
},
bpid: {
type: "string",
example: "ifle-org1",
description: "The organization's Business Partner ID"
},
description: {
type: "string",
example: "my organization",
description: "The organization's description"
},
source: {
type: "string",
description: "The origin of the organization details",
enum: ["SELF_REGISTRATION", "BACK_OFFICE", "IT_ADMIN", "IMPORT"],
example: "IT_ADMIN"
},
type: {
type: "string",
description: "The organization type",
example: "DISTRIBUTOR"
},
status: {
type: "string",
description: "The organization status",
example: "APPROVED"
},
info: {
type: "object",
properties: {
city: {
type: "array",
items: {
type: "string",
example: "P-T"
},
description: "The organization city"
},
state: {
type: "array",
items: {
type: "string",
example: "center",
description: "The organization state"
}
},
country: {
type: "array",
items: {
type: "string",
example: "germany",
description: "The organization country"
}
},
zip_code: {
type: "array",
items: {
type: "string",
example: 4925964,
description: "The organization zip code"
}
},
street_address: {
type: "array",
items: {
type: "string",
example: "strusburg 143",
description: "The organization address line"
}
}
}
},
memberLimit: {
type: "number",
description: "The max number of organization members",
example: 100
}
}
};
const B2BSearchRequestSchema = {
description: "Search Organization Request",
oneOf: [
{
"$ref": "#/components/schemas/B2BSearchQuery"
},
{
"$ref": "#/components/schemas/B2BSearchNextCursor"
}
]
};
const B2BSearchQuerySchema = {
required: ["query"],
properties: {
query: {
type: "string",
examples: ["select * from organizations where status = 'APROVED'", "select * from organizations where status = 'APROVED' and type = 'DISTRIBUTOR'", "select status, type from organizations where status = 'Denied'", "SELECT * FROM organizations", 'SELECT * FROM organization_requests WHERE created > "YYYY-MM-DDThh.mm.ss.msmsmsZ"', 'SELECT * FROM organization_requests WHERE created > "2023-03-26T13:12:02.752Z"'],
pattern: "SELECT\\s+\\*\\s+FROM\\s+(organizations|organization_requests)\\s+WHERE\\s+(\\w+\\s*(=|>|<|>=|<=|!=|IN)\\s*('[^']*'|\\d+|\\w+|\\(\\s*\\d+\\s*,\\s*\\d+\\s*\\)|\\(\\s*'[^']*'\\s*,\\s*'[^']*'\\s*\\))\\s*(AND\\s+\\w+\\s*(=|>|<|>=|<=|!=|IN)\\s*('[^']*'|\\d+|\\w+|\\(\\s*\\d+\\s*,\\s*\\d+\\s*\\)|\\(\\s*'[^']*'\\s*,\\s*'[^']*'\\s*\\))\\s*)*)?(\\s+ORDER\\s+BY\\s+\\w+\\s+(ASC|DESC))?\\s*(\\s+LIMIT\\s+\\d+)?\\s*;?",
description: `An SQL-like query specifying the data to retrieve.
Please refer to the Query language specification section above.
When using cursors, this parameter should only be sent with the initial request
and omitted from subsequent requests
`
},
openCursor: {
type: "boolean",
example: true,
description: `When set to true, the search response will include,
in addition to the first page, another field named __nextCursorId__,
which is used to fetch the next batch of results.
This parameter should only be used on the first request and later should be
removed from the request.
When openCursor is active, the Limit clause sets the number of results returned in the batch.
* You cannot pass both cursorId and query on the same request - cursorId brings
the next page for the search for which it was opened.
Also, the time between search requests using a cursorId must not exceed 5 minutes.
* Each request should contain a different cursorId obtained
from the response of the previous request (not the first) using
the nextCursorId field. The exception to this rule is when a request fails or
when a particular result set needs to be resent; in this case,
resend the same cursorID (as long as it has not expired) to receive its associated result set.
`
},
timeout: {
type: "number",
example: 1e3,
description: `The timeout for the request (in milliseconds). Default value is 20000 (20 seconds).
Maximum allowed value is 60000 (60 seconds).
`
}
}
};
const B2BSearchNextCursorSchema = {
properties: {
cursorId: {
type: "string",
example: "abcf14gfte",
description: `The cursor ID that contains the __nextCursorId__ value received in the first search call
`
}
}
};
const setup_bootstrap_responseSchema = {
"x-tags": ["setup.bootstrap_response"],
type: "object",
allOf: [
{
"$ref": "#/components/schemas/ok_response"
},
{
properties: {
authWorkspaces: {
type: "array",
items: {
type: "object",
properties: {
authWsId: {
type: "string",
description: "Authentication work space Id",
example: "efdf85b9-b4ff-4e2a-9006-566743fb8bc9"
},
clientId: {
type: "string",
description: "Client Id",
example: "PPZ8CFWO7ENB5H9EQGMF"
}
}
}
}
}
}
]
};
const DSGetResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ok_response"
},
{
properties: {
object: {
"$ref": "#/components/schemas/DSObject"
}
}
}
]
};
const DSObjectSchema = {
type: "object",
properties: {
oid: {
type: "string"
},
lastUpdated: {
type: "integer",
format: "int64"
},
lastUpdatedTime: {
type: "string"
},
created: {
type: "integer",
format: "int64"
},
createdTime: {
type: "string"
},
data: {
type: "object"
}
}
};
const DSStoreParamsSchema = {
type: "object",
properties: {
data: {
type: "object"
},
type: {
type: "string"
},
oid: {
type: "string"
},
UID: {
type: "string"
},
updateBehavior: {
type: "string",
enum: ["arrayPush", "arraySet", "replace"]
}
}
};
const DSStoreResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ok_response"
},
{
properties: {
oid: {
type: "string"
}
}
}
]
};
const DSSearchResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ok_response"
},
{
type: "object",
properties: {
objectsCount: {
type: "integer",
format: "int32"
},
totalCount: {
type: "integer",
format: "int32"
},
results: {
type: "array",
items: {
"$ref": "#/components/schemas/DSObject"
}
},
nextCursorId: {
type: "string"
}
}
}
]
};
const DSSearchParamsSchema = {
type: "object",
properties: {
query: {
type: "string"
},
openCursor: {
type: "boolean"
},
cursorId: {
type: "boolean"
},
timeout: {
type: "integer",
format: "int32"
}
}
};
const SetDSSchemaRequestSchema = {
type: "object",
properties: {
type: {
type: "string"
},
dataSchema: {
"$ref": "#/components/schemas/DataSchema"
}
}
};
const SetDSSchemaResponseSchema = {
type: "object",
"$ref": "#/components/schemas/ok_response"
};
const GetDSSchemaRequestSchema = {
type: "object",
properties: {
type: {
type: "string"
},
filter: {
type: "string",
enum: ["full", "clientOnly", "explicitOnly"]
}
}
};
const GetDSSchemaResponseSchema = {
properties: {
schema: {
"$ref": "#/components/schemas/Schema"
}
}
};
const DataSchemaSchema = {
allOf: [
{
"$ref": "#/components/schemas/Schema"
},
{
properties: {
dynamicSchema: {
type: "boolean"
}
}
}
]
};
const SchemaSchema = {
example: {
rel2: {
type: "string",
writeAccess: "serverOnly",
required: false
},
email_rel: {
type: "string",
writeAccess: "serverOnly",
required: false,
format: "([a-zA-Z0-9\\_\\-\\.]+)@([a-zA-Z]+).(.+)"
}
},
type: "object",
additionalProperties: {
"$ref": "#/components/schemas/SchemaField"
}
};
const SchemaFieldSchema = {
type: "object",
properties: {
type: {
type: "string",
enum: ["integer", "float", "boolean", "string", "date", "long", "text", "binary"]
},
writeAccess: {
type: "string",
enum: ["serverOnly", "clientModify", "clientCreate"]
},
required: {
type: "boolean"
},
format: {
type: "string"
},
encrypt: {
type: "string",
enum: ["aes"]
}
}
};
const ApiResponseSchema = {
type: "object",
properties: {
callId: {
type: "string"
},
errorCode: {
type: "integer"
},
apiVersion: {
type: "integer"
},
statusCode: {
type: "integer"
},
statusReason: {
type: "string"
}
}
};
const RemoveMemberResponseSchema = {
"$ref": "#/components/schemas/ApiResponse"
};
const GetGroupInfoResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
memberSince: {
type: "string",
format: "date-time"
},
lastUpdated: {
type: "string",
format: "date-time"
},
permissions: {
type: "array",
items: {
type: "string"
}
}
}
}
]
};
const GetGroupMemberInfoResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
result: {
allOf: [
{
"$ref": "#/components/schemas/MemberInfo"
},
{
"$ref": "#/components/schemas/GroupId"
}
]
}
}
}
]
};
const GetAllMemberGroupsResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
allOf: [
{
"$ref": "#/components/schemas/GroupInfo"
},
{
"$ref": "#/components/schemas/MemberInfo"
}
]
}
]
};
const CreateModelResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
modelId: {
type: "string"
}
}
}
]
};
const DeleteModelResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
deleted: {
type: "boolean"
}
}
}
]
};
const AllModelsResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
models: {
type: "array",
items: {
type: "object",
properties: {
model: {
type: "string"
},
selfProvisioning: {
type: "boolean"
}
}
}
}
}
}
]
};
const DeleteSchemaFieldResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
deleted: {
type: "boolean"
}
}
}
]
};
const GetGroupSchemaResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
model: {
type: "string"
},
groupDataSchema: {
type: "object",
"$ref": "#/components/schemas/GroupSchema"
},
relationshipDataSchema: {
type: "object",
"$ref": "#/components/schemas/GroupSchema"
}
}
}
]
};
const SetGroupSchemaResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object"
}
]
};
const DeleteGroupResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
deleted: {
type: "boolean"
}
}
}
]
};
const AllMemberGroupsResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
groups: {
type: "array",
items: {
type: "object"
}
}
}
}
]
};
const GroupInfoResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
groupInfo: {
type: "object"
}
}
}
]
};
const RegisterGroupResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
groupId: {
type: "string"
}
}
}
]
};
const SetGroupInfoResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
updated: {
type: "boolean"
}
}
}
]
};
const GetGroupSchemaRequestSchema = {
type: "object",
properties: {
model: {
type: "string",
description: `The group's type model. The model must be registered in the system.
`
}
}
};
const CreateModelRequestSchema = {
type: "object",
properties: {
model: {
type: "string",
description: `The name of the model.
`
},
selfProvisioning: {
type: "boolean",
description: `If true, the client will be able to create a group using the createGroup call,
`
}
}
};
const SetGroupMemberInfoResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object"
}
]
};
const CreateInvitationResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
invitationLink: {
type: "string",
format: "uri"
}
}
}
]
};
const FinalizeInvitationResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object"
}
]
};
const SetSiteConfigResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object"
}
]
};
const GetGroupInfoRequestSchema = {
type: "object",
properties: {
results: {
type: "array",
items: {
"$ref": "#/components/schemas/MemberInfo"
}
}
}
};
const GetGroupMemberInfoRequestSchema = {
type: "object",
properties: {
groupId: {
type: "string"
},
model: {
type: "string"
},
include: {
type: "string",
description: `Only accepts the profile parameter.
`,
enum: ["profile"]
}
}
};
const GetAllMemberGroupsRequestSchema = {
type: "object"
};
const DeleteModelRequestSchema = {
type: "object",
properties: {
modelId: {
type: "string"
}
}
};
const RegisterGroupRequestSchema = {
type: "object",
properties: {
groupName: {
type: "string"
},
groupDescription: {
type: "string"
}
}
};
const SetGroupInfoRequestSchema = {
type: "object",
properties: {
model: {
type: "string",
description: `The group's type model. The model must be registered in the system.
`
},
groupId: {
type: "string"
},
groupData: {
"$ref": "#/components/schemas/GroupData"
}
}
};
const AssignGroupMemberRequestSchema = {
type: "object",
properties: {
groupId: {
type: "string"
},
UID: {
type: "string"
}
}
};
const AssignGroupMemberResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object"
}
]
};
const DeleteSchemaFieldRequestSchema = {
type: "object",
properties: {
model: {
type: "string",
description: `The group's type model. The model must be registered in the system.
`
},
groupDataSchemaFieldName: {
type: "string",
description: `This is the field name of the data schema for the group.
SetGroupMemberInfoRequest
`
},
relationshipDataSchemaFieldName: {
type: "string",
description: `This is the field name of the data schema for the relationship data.
SetGroupMemberInfoRequest
`
}
}
};
const SetGroupMemberInfoRequestSchema = {
type: "object",
allOf: [
{
"$ref": "#/components/schemas/MemberInfo"
},
{
"$ref": "#/components/schemas/GroupId"
}
]
};
const RemoveMemberRequestSchema = {
"$ref": "#/components/schemas/GroupId"
};
const CreateInvitationRequestSchema = {
type: "object",
properties: {
model: {
type: "string"
},
groupId: {
type: "string"
}
}
};
const InvitationConfirmRequestSchema = {
type: "object",
properties: {
invitationId: {
type: "string"
},
confirmationCode: {
type: "string"
}
}
};
const InvitationConfirmResponseSchema = {
allOf: [
{
"$ref": "#/components/schemas/ApiResponse"
},
{
type: "object",
properties: {
confirmed: {
type: "boolean"
}
}
}
]
};
const FinalizeInvitationRequestSchema = {
type: "object",
properties: {
invitationId: {
type: "string"
},
finalCode: {
type: "string"
}
}
};
const SetSiteConfigRequestSchema = {
type: "object",
properties: {
configKey: {
type: "string"
},
configValue: {
type: "string"
}
}
};
const SetGroupSchemaRequestSchema = {
type: "object",
properties: {
model: {
type: "string",
description: `The group's type model. The model must be registered in the system.
`
},
groupDataSchema: {
"$ref": "#/components/schemas/GroupSchema"
},
relationshipDataSchema: {
"$ref": "#/components/schemas/GroupSchema"
}
}
};
const GroupIdSchema = {
properties: {
groupId: {
type: "string",
description: `The group's unique identifier.
`
},
model: {
description: `The group's type model.
`
}
}
};
const GroupInfoSchema = {
allOf: [
{
"$ref": "#/components/schemas/GroupId"
},
{
properties: {
groupData: {
"$ref": "#/components/schemas/GroupData"
}
}
}
]
};
const GroupDataSchema = {
type: "object",
description: `The group's data based on the group data schema for the defined group.
`,
example: {
BPID: "poc_bpid1",
source: "IMPORT",
country: "Israel"
}
};
const MemberInfoSchema = {
type: "object",
properties: {
UID: {
type: "string"
},
memberSince: {
type: "string",
format: "date-time",
readOnly: true
},
lastUpdated: {
type: "string",
format: "date-time",
readOnly: true
},
memberSinceTimestamp: {
type: "integer",
format: "int64",
readOnly: true
},
lastUpdatedTimestamp: {
type: "integer",
format: "int64",
readOnly: true
},
permissions: {
"$ref": "#/components/schemas/Permissions"
},
relationshipData: {
"$ref": "#/components/schemas/RelationshipData"
}
}
};
const PermissionsSchema = {
description: `This parameter supports a comma-separated list of group permissions for members. Permission Values include: groupRead, groupWrite, groupDelete, relationshipRead, relationshipWrite, membersInvite, membersRemove, setPermissions) In case the setPermissions is provided - by default the relationshipRead and relationshipWrite permissions will be added if they are not provided.
`,
type: "string",
pattern: "^(groupRead|groupWrite|groupDelete|relationshipRead|relationshipWrite|membersInvite|membersRemove|setPermissions)(,(groupRead|groupWrite|groupDelete|relationshipRead|relationshipWrite|membersInvite|membersRemove|setPermissions))*$",
example: "groupRead,groupWrite,groupDelete,relationshipRead,relationshipWrite,membersInvite"
};
const RelationshipDataSchema = {
type: "object",
description: `The user's relationship data based on the relationship data schema for the defined group.
`,
example: {
field1: "value1",
field2: "value2"
}
};
const GroupSchemaSchema = {
example: {
rel2: {
type: "string",
writeAccess: "serverOnly",
required: false
},
email_rel: {
type: "string",
writeAccess: "serverOnly",
required: false,
format: "([a-zA-Z0-9\\_\\-\\.]+)@([a-zA-Z]+).(.+)"
}
},
type: "object",
additionalProperties: {
"$ref": "#/components/schemas/DataSchemaField"
}
};
const DataSchemaFieldSchema = {
type: "object",
properties: {
type: {
type: "string",
enum: ["string", "integer", "number", "boolean", "array", "object"]
},
writeAccess: {
type: "string",
enum: ["serverOnly", "clientModify"]
},
required: {
type: "boolean"
},
format: {
type: "string"
}
}
};
const ActivityBlueprintModelSchema = {
type: "object",
properties: {
id: {
type: "string"
},
name: {
type: "string"
},
displayName: {
type: "string"
},
description: {
type: "string"
},
type: {
type: "string"
},
parentId: {
type: "string"
},
persistWorkflow: {
type: "boolean"
},
loadWorkflowContext: {
type: "boolean"
},
saveWorkflowContext: {
type: "boolean"
},
inputProperties: {
"$ref": "#/components/schemas/Variables"
},
outputProperties: {
"$ref": "#/components/schemas/Variables"
}
},
additionalProperties: false
};
const ActivityDefinitionSchema = {
type: "object",
properties: {
activityId: {
type: "string"
},
type: {
type: "string"
},
name: {
type: "string"
},
displayName: {
type: "string"
},
description: {
type: "string"
},
persistWorkflow: {
type: "boolean"
},
loadWorkflowContext: {
type: "boolean"
},
saveWorkflowContext: {
type: "boolean"
},
properties: {
type: "array",
items: {
"$ref": "#/components/schemas/ActivityDefinitionProperty"
}
},
propertyStorageProviders: {
type: "object",
additionalProperties: {
type: "string"
},
readOnly: true
}
},
additionalProperties: false
};
const ActivityDefinitionPropertySchema = {
type: "object",
properties: {
name: {
type: "string"
},
syntax: {
type: "string"
},
expressions: {
type: "object",
additionalProperties: {
type: "string"
}
}
},
additionalProperties: false
};
const ActivityDescriptorSchema = {
type: "object",
properties: {
type: {
type: "string"
},
displayName: {
type: "string"
},
description: {
type: "string"
},
category: {
type: "string"
},
traits: {
"$ref": "#/components/schemas/ActivityTraits"
},
outcomes: {
type: "array",
items: {
type: "string"
}
},
properties: {
type: "array",
items: {
"$ref": "#/components/schemas/ActivityInputDescriptor"
},
deprecated: true
},
inputProperties: {
type: "array",
items: {
"$ref": "#/components/schemas/ActivityInputDescriptor"
}
},
outputProperties: {
type: "array",
items: {
"$ref": "#/components/schemas/ActivityOutputDescriptor"
}
}
},
additionalProperties: false
};
const ActivityInputDescriptorSchema = {
type: "object",
properties: {
name: {
type: "string"
},
type: {
type: "string",
example: "System.String, mscorlib"
},
uiHint: {
type: "string"
},
label: {
type: "string"
},
hint: {
type: "string"
},
options: {
type: "object",
additionalProperties: {}
},
category: {
type: "string"
},
order: {
type: "number",
format: "float"
},
defaultValue: {
"$ref": "#/components/schemas/Input"
},
defaultSyntax: {
type: "string"
},
supportedSyntaxes: {
type: "array",
items: {
type: "string"
}
},
isReadOnly: {
type: "boolean"
},
isBrowsable: {
type: "boolean"
},
isDesignerCritical: {
type: "boolean"
},
defaultWorkflowStorageProvider: {
type: "string"
},
disableWorkflowProviderSelection: {
type: "boolean"
}
},
additionalProperties: false
};
const ActivityOutputDescriptorSchema = {
type: "object",
properties: {
name: {
type: "string"
},
type: {
type: "string",
example: "System.String, mscorlib"
},
hint: {
type: "string"
},
defaultWorkflowStorageProvider: {
type: "string"
},
disableWorkflowProviderSelection: {
type: "boolean"
}
},
additionalProperties: false
};
const ActivityScopeSchema = {
type: "object",
properties: {
activityId: {
type: "string"
},
variables: {
"$ref": "#/components/schemas/Variables"
}
},
additionalProperties: false
};
const ActivityTraitsSchema = {
enum: [1, 2, 4],
type: "integer",
format: "int32"
};
const BlockingActivitySchema = {
type: "object",
properties: {
activityId: {
type: "string"
},
activityType: {
type: "string"
},
tag: {
type: "string"
}
},
additionalProperties: false
};
const BulkCancelWorkflowsRequestSchema = {
type: "object",
properties: {
workflowInstanceIds: {
type: "array",
items: {
type: "string"
}
}
},
additionalProperties: false
};
const BulkDeleteWorkflowsRequestSchema = {
type: "object",
properties: {
workflowInstanceIds: {
type: "array",
items: {
type: "string"
}
}
},
additionalProperties: false
};
const BulkRetryWorkflowsRequestSchema = {
type: "object",
properties: {
workflowInstanceIds: {
type: "array",
items: {
type: "string"
}
}
},
additionalProperties: false
};
const ConnectionDefinitionSchema = {
type: "object",
properties: {
sourceActivityId: {
type: "string"
},
targetActivityId: {
type: "string"
},
outcome: {
type: "string"
}
},
additionalProperties: false
};
const ConnectionModelSchema = {
type: "object",
properties: {
sourceActivityId: {
type: "string"
},
targetActivityId: {
type: "string"
},
outcome: {
type: "string"
}
},
additionalProperties: false
};
const InstantSchema = {
type: "object",
additionalProperties: false
};
const IOutputFormatterSchema = {
type: "object",
additionalProperties: false
};
const JTokenSchema = {
type: "array",
items: {
"$ref": "#/components/schemas/JToken"
}
};
const OkObjectResultSchema = {
type: "object",
properties: {
value: {
"$ref": "#/components/schemas/Input"
},
formatters: {
type: "array",
items: {
"$ref": "#/components/schemas/IOutputFormatter"
}
},
contentTypes: {
type: "array",
items: {
type: "string"
}
},
declaredType: {
type: "string",
example: "System.String, mscorlib"
},
statusCode: {
type: "integer",
format: "int32"
}
},
additionalProperties: false
};
const OrderBySchema = {
enum: [0, 1, 2],
type: "integer",
format: "int32"
};
const ProblemDetailsSchema = {
type: "object",
properties: {
type: {
type: "string"
},
title: {
type: "string"
},
status: {
type: "integer",
format: "int32"
},
detail: {
type: "string"
},
instance: {
type: "string"
}
},
additionalProperties: {}
};
const RetryWorkflowRequestSchema = {
type: "object",
properties: {
runImmediately: {
type: "boolean"
}
},
additionalProperties: false
};
const RuntimeSelectListItemsContextHolderSchema = {
type: "object",
properties: {
providerTypeName: {
type: "string"
},
context: {
type: "object",
additionalProperties: {}
}
}
};
const SaveWorkflowDefinitionRequestSchema = {
type: "object",
properties: {
workflowDefinitionId: {
type: "string"
},
name: {
type: "string"
},
displayName: {
type: "string"
},
description: {
type: "string"
},
tag: {
type: "string"
},
channel: {
type: "string"
},
variables: {
"$ref": "#/components/schemas/Variables"
},
contextOptions: {
"$ref": "#/components/schemas/WorkflowContextOptions"
},
isSingleton: {
type: "boolean"
},
persistenceBehavior: {
"$ref": "#/components/schemas/WorkflowPersistenceBehavior"
},
deleteCompletedInstances: {
type: "boolean"
},
publish: {
type: "boolean"
},
activities: {
type: "array",
items: {
"$ref": "#/components/schemas/ActivityDefinition"
}
},
connections: {
type: "array",
items: {
"$ref": "#/components/schemas/ConnectionDefinition"
}
}
},
additionalProperties: false
};
const ScheduledActivitySchema = {
type: "object",
properties: {
activityId: {
type: "string"
},
input: {
"$ref": "#/components/schemas/Input"
}
},
additionalProperties: false
};
const SimpleExceptionSchema = {
type: "object",
properties: {
type: {
type: "string",
example: "System.String, mscorlib"
},
message: {
type: "string"
},
stackTrace: {
type: "string"
},
innerException: {
"$ref": "#/components/schemas/SimpleException"
},
data: {
type: "object",
additionalProperties: {}
}
},
additionalProperties: false
};
const VariablesSchema = {
type: "object",
properties: {
data: {
type: "object",
additionalProperties: {},
readOnly: true
}
},
additionalProperties: false
};
const VersionOptionsSchema = {
type: "object",
properties: {
isLatest: {
type: "boolean",
readOnly: true
},
isLatestOrPublished: {
type: "boolean",
readOnly: true
},
isPublished: {
type: "boolean",
readOnly: true
},
isDraft: {
type: "boolean",
readOnly: true
},
allVersions: {
type: "boolean",
readOnly: true
},
version: {
type: "integer",
format: "int32",
readOnly: true
}
},
additionalProperties: false
};
const WorkflowBlueprintModelSchema = {
type: "object",
properties: {
id: {
type: "string"
},
name: {
type: "string"
},
displayName: {
type: "string"
},
description: {
type: "string"
},
type: {
type: "string"
},
parentId: {
type: "string"
},
persistWorkflow: {
type: "boolean"
},
loadWorkflowContext: {
type: "boolean"
},
saveWorkflowContext: {
type: "boolean"
},
inputProperties: {
"$ref": "#/components/schemas/Variables"
},
outputProperties: {
"$ref": "#/components/schemas/Variables"
},
activities: {
type: "array",
items: {
"$ref": "#/components/schemas/ActivityBlueprintModel"
}
},
connections: {
type: "array",
items: {
"$ref": "#/components/schemas/ConnectionModel"
}
},
version: {
type: "integer",
format: "int32"
},
tenantId: {
type: "string"
},
isSingleton: {
type: "boolean"
},
isEnabled: {
type: "boolean"
},
isPublished: {
type: "boolean"
},
isLatest: {
type: "boolean"
},
isDisabled: {
type: "boolean"
},
variables: {
"$ref": "#/components/schemas/Variables"
},
contextOptions: {
"$ref": "#/components/schemas/WorkflowContextOptions"
},
persistenceBehavior: {
"$ref": "#/components/schemas/WorkflowPersistenceBehavior"
},
deleteCompletedInstances: {
type: "boolean"
},
customAttributes: {
"$ref": "#/components/schemas/Variables"
}
},
additionalProperties: false
};
const WorkflowBlueprintModelPagedListSchema = {
type: "object",
properties: {
items: {
type: "array",
items: {
"$ref": "#/components/schemas/WorkflowBlueprintModel"
}
},
page: {
type: "integer",
format: "int32",
readOnly: true
},
pageSize: {
type: "integer",
format: "int32",
readOnly: true
},
totalCount: {
type: "integer",
format: "int32",
readOnly: true
}
},
additionalProperties: false
};
const WorkflowBlueprintSummaryModelSchema = {
type: "object",
properties: {
id: {
type: "string"
},
name: {
type: "string"
},
displayName: {
type: "string"
},
description: {
type: "string"
},
version: {
type: "integer",
format: "int32"
},
tenantId: {
type: "string"
},
isSingleton: {
type: "boolean"
},
isPublished: {
type: "boolean"
},
isLatest: {
type: "boolean"
},
isDisabled: {
type: "boolean"
}
},
additionalProperties: false
};
const WorkflowBlueprintSummaryModelPagedListSchema = {
type: "object",
properties: {
items: {
type: "array",
items: {
"$ref": "#/components/schemas/WorkflowBlueprintSummaryModel"
}
},
page: {
type: "integer",
format: "int32",
readOnly: true
},
pageSize: {
type: "integer",
format: "int32",
readOnly: true
},
totalCount: {
type: "integer",
format: "int32",
readOnly: true
}
},
additionalProperties: false
};
const WorkflowContextFidelitySchema = {
enum: [0, 1],
type: "integer",
format: "int32"
};
const WorkflowContextOptionsSchema = {
type: "object",
properties: {
contextType: {
type: "string",
example: "System.String, mscorlib"
},
contextFidelity: {
"$ref": "#/components/schemas/WorkflowContextFidelity"
}
},
additionalProperties: false
};
const WorkflowDefinitionSchema = {
type: "object",
properties: {
id: {
type: "string"
},
definitionId: {
type: "string"
},
versionId: {
type: "string",
readOnly: true
},
tenantId: {
type: "string"
},
name: {
type: "string"
},
displayName: {
type: "string"
},
description: {
type: "string"
},
channel: {
type: "string"
},
version: {
type: "integer",
format: "int32"
},
variables: {
"$ref": "#/components/schemas/Variables"
},
customAttributes: {
"$ref": "#/components/schemas/Variables"
},
contextOptions: {
"$ref": "#/components/schemas/WorkflowContextOptions"
},
isSingleton: {
type: "boolean"
},
persistenceBehavior: {
"$ref": "#/components/schemas/WorkflowPersistenceBehavior"
},
deleteCompletedInstances: {
type: "boolean"
},
isPublished: {
type: "boolean"
},
isLatest: {
type: "boolean"
},
tag: {
type: "string"
},
activities: {
type: "array",
items: {
"$ref": "#/components/schemas/ActivityDefinition"
}
},
connections: {
type: "array",
items: {
"$ref": "#/components/schemas/ConnectionDefinition"
}
}
},
additionalProperties: false
};
const WorkflowDefinitionSummaryModelSchema = {
type: "object",
properties: {
id: {
type: "string"
},
definitionId: {
type: "string"
},
name: {
type: "string"
},
displayName: {
type: "string"
},
description: {
type: "string"
},
version: {
type: "integer",
format: "int32"
},
isSingleton: {
type: "boolean"
},
persistenceBehavior: {
"$ref": "#/components/schemas/WorkflowPersistenceBehavior"
},
isPublished: {
type: "boolean"
},
isLatest: {
type: "boolean"
}
},
additionalProperties: false
};
const WorkflowDefinitionSummaryModelPagedListSchema = {
type: "object",
properties: {
items: {
type: "array",
items: {
"$ref": "#/components/schemas/WorkflowDefinitionSummaryModel"
}
},
page: {
type: "integer",
format: "int32",
readOnly: true
},
pageSize: {
type: "integer",
format: "int32",
readOnly: true
},
totalCount: {
type: "integer",
format: "int32",
readOnly: true
}
},
additionalProperties: false
};
const WorkflowExecutionLogRecordSchema = {
type: "object",
properties: {
id: {
type: "string"
},
tenantId: {
type: "string",
readOnly: true
},
workflowInstanceId: {
type: "string"
},
activityId: {
type: "string"
},
activityType: {
type: "string"
},
timestamp: {
"$ref": "#/components/schemas/Instant"
},
eventName: {
type: "string"
},
message: {
type: "string"
},
source: {
type: "string"
},
data: {
type: "object",
additionalProperties: {
"$ref": "#/components/schemas/JToken"
}
}
},
additionalProperties: false
};
const WorkflowExecutionLogRecordPagedListSchema = {
type: "object",
properties: {
items: {
type: "array",
items: {
"$ref": "#/components/schemas/WorkflowExecutionLogRecord"
}
},
page: {
type: "integer",
format: "int32",
readOnly: true
},
pageSize: {
type: "integer",
format: "int32",
readOnly: true
},
totalCount: {
type: "integer",
format: "int32",
readOnly: true
}
},
additionalProperties: false
};
const WorkflowFaultSchema = {
type: "object",
properties: {
exception: {
"$ref": "#/components/schemas/SimpleException"
},
message: {
type: "string"
},
faultedActivityId: {
type: "string"
},
activityInput: {
"$ref": "#/components/schemas/Input"
},
resuming: {
type: "boolean"
}
},
additionalProperties: false
};
const InputSchema = {
type: ["object", "string", "number"]
};
const WorkflowInputReferenceSchema = {
type: "object",
properties: {
providerName: {
type: "string"
}
},
additionalProperties: false
};
const WorkflowInstanceSchema = {
type: "object",
properties: {
id: {
type: "string"
},
definitionId: {
type: "string"
},
tenantId: {
type: "string"
},
version: {
type: "integer",
format: "int32"
},
workflowStatus: {
"$ref": "#/components/schemas/WorkflowStatus"
},
correlationId: {
type: "string"
},
contextType: {
type: "string"
},
contextId: {
type: "string"
},
name: {
type: "string"
},
createdAt: {
"$ref": "#/components/schemas/Instant"
},
lastExecutedAt: {
"$ref": "#/components/schemas/Instant"
},
finishedAt: {
"$ref": "#/components/schemas/Instant"
},
cancelledAt: {
"$ref": "#/components/schemas/Instant"
},
faultedAt: {
"$ref": "#/components/schemas/Instant"
},
variables: {
"$ref": "#/components/schemas/Variables"
},
input: {
"$ref": "#/components/schemas/WorkflowInputReference"
},
output: {
"$ref": "#/components/schemas/WorkflowOutputReference"
},
activityData: {
description: "activities stored attributes, for example loginActivity.amr, invitiation.email",
type: "object",
additionalProperties: {
type: "object",
additionalProperties: {}
}
},
blockingActivities: {
description: "Blocking activities are activities that can be used to trigger the start of a workflow or resume suspended ones.",
uniqueItems: true,
type: "array",
items: {
"$ref": "#/components/schemas/BlockingActivity"
}
},
fault: {
"$ref": "#/components/schemas/WorkflowFault"
},
scheduledActivities: {
type: "array",
items: {
"$ref": "#/components/schemas/ScheduledActivity"
}
},
scopes: {
type: "array",
items: {
"$ref": "#/components/schemas/ActivityScope"
}
},
currentActivity: {
"$ref": "#/components/schemas/ScheduledActivity"
},
lastExecutedActivityId: {
type: "string"
}
},
additionalProperties: false
};
const WorkflowInstanceSummaryModelSchema = {
type: "object",
properties: {
id: {
type: "string"
},
definitionId: {
type: "string"
},
tenantId: {
type: "string"
},
version: {
type: "integer",
format: "int32"
},
workflowStatus: {
"$ref": "#/components/schemas/WorkflowStatus"
},
correlationId: {
type: "string"
},
contextType: {
type: "string"
},
contextId: {
type: "string"
},
name: {
type: "string"
},
createdAt: {
"$ref": "#/components/schemas/Instant"
},
lastExecutedAt: {
"$ref": "#/components/schemas/Instant"
},
finishedAt: {
"$ref": "#/components/schemas/Instant"
},
cancelledAt: {
"$ref": "#/components/schemas/Instant"
},
faultedAt: {
"$ref": "#/components/schemas/Instant"
}
},
additionalProperties: false
};
const WorkflowInstanceSummaryModelPagedListSchema = {
type: "object",
properties: {
items: {
type: "array",
items: {
"$ref": "#/components/schemas/WorkflowInstanceSummaryModel"
}
},
page: {
type: "integer",
format: "int32",
readOnly: true
},
pageSize: {
type: "integer",
format: "int32",
readOnly: true
},
totalCount: {
type: "integer",
format: "int32",
readOnly: true
}
},
additionalProperties: false
};
const WorkflowOutputReferenceSchema = {
type: "object",
properties: {
providerName: {
type: "string"
},
activityId: {
type: "string"
}
},
additionalProperties: false
};
const WorkflowPersistenceBehaviorSchema = {
enum: [0, 1, 2],
type: "integer",
format: "int32"
};
const WorkflowStatusSchema = {
enum: [0, 1, 2, 3, 4, 5],
type: "integer",
format: "int32"
};
const certificatesResponseSchema = {
type: "object",
properties: {