Trackon Software AWS Backend API
This is the documentation for Trackon Software AWS Backend API GraphQL API.
API Endpoints
https://zqshpj5deva55l6b6hnjxgjhpa.appsync-api.us-east-1.amazonaws.com/graphqlVersion
1.0.0
Queries
batchCheckAuthorization
Response
Returns [AuthorizationResult!]!
Arguments
| Name | Description |
|---|---|
request - BatchAuthorizationRequest!
|
Example
Query
query batchCheckAuthorization($request: BatchAuthorizationRequest!) {
batchCheckAuthorization(request: $request) {
isAuthorized
entityName
entityId
action
message
}
}
Variables
{"request": BatchAuthorizationRequest}
Response
{
"data": {
"batchCheckAuthorization": [
{
"isAuthorized": false,
"entityName": "abc123",
"entityId": "abc123",
"action": "xyz789",
"message": "xyz789"
}
]
}
}
batchListEntity
Response
Returns a ListEntitiesResponse
Example
Query
query batchListEntity(
$tenantId: String!,
$entityName: String!,
$ids: [ID!]!,
$limit: Int,
$nextToken: String,
$includeReferences: Boolean,
$includeDetails: Boolean
) {
batchListEntity(
tenantId: $tenantId,
entityName: $entityName,
ids: $ids,
limit: $limit,
nextToken: $nextToken,
includeReferences: $includeReferences,
includeDetails: $includeDetails
) {
success
message
entities {
...EntityFragment
}
nextToken
error
}
}
Variables
{
"tenantId": "xyz789",
"entityName": "xyz789",
"ids": ["4"],
"limit": 987,
"nextToken": "abc123",
"includeReferences": true,
"includeDetails": false
}
Response
{
"data": {
"batchListEntity": {
"success": true,
"message": "abc123",
"entities": [Entity],
"nextToken": "abc123",
"error": "xyz789"
}
}
}
checkAuthorization
Description
AVP Related
Response
Returns an AuthorizationResult!
Arguments
| Name | Description |
|---|---|
request - AuthorizationRequest!
|
Example
Query
query checkAuthorization($request: AuthorizationRequest!) {
checkAuthorization(request: $request) {
isAuthorized
entityName
entityId
action
message
}
}
Variables
{"request": AuthorizationRequest}
Response
{
"data": {
"checkAuthorization": {
"isAuthorized": false,
"entityName": "abc123",
"entityId": "xyz789",
"action": "xyz789",
"message": "abc123"
}
}
}
getEntityMetadata
Response
Returns an EntityMetadata
Example
Query
query getEntityMetadata(
$tenantId: String!,
$entityName: String!
) {
getEntityMetadata(
tenantId: $tenantId,
entityName: $entityName
) {
entityName
attributes
IDGeneration
pkFormula
skFormula
pk1Formula
sk1Formula
pk2Formula
sk2Formula
pk3Formula
sk3Formula
pk4Formula
sk4Formula
pk5Formula
sk5Formula
pk6Formula
sk6Formula
pk7Formula
sk7Formula
pk8Formula
sk8Formula
pk9Formula
sk9Formula
pk10Formula
sk10Formula
formLayout
lovs
extractionPrompt
entityParameters
entityStates
workflowTriggers
referentialConstraints
detailEntities
}
}
Variables
{
"tenantId": "xyz789",
"entityName": "xyz789"
}
Response
{
"data": {
"getEntityMetadata": {
"entityName": "xyz789",
"attributes": AWSJSON,
"IDGeneration": AWSJSON,
"pkFormula": "abc123",
"skFormula": "xyz789",
"pk1Formula": "abc123",
"sk1Formula": "abc123",
"pk2Formula": "xyz789",
"sk2Formula": "abc123",
"pk3Formula": "xyz789",
"sk3Formula": "abc123",
"pk4Formula": "abc123",
"sk4Formula": "abc123",
"pk5Formula": "abc123",
"sk5Formula": "abc123",
"pk6Formula": "xyz789",
"sk6Formula": "abc123",
"pk7Formula": "xyz789",
"sk7Formula": "xyz789",
"pk8Formula": "xyz789",
"sk8Formula": "abc123",
"pk9Formula": "xyz789",
"sk9Formula": "xyz789",
"pk10Formula": "abc123",
"sk10Formula": "xyz789",
"formLayout": [AWSJSON],
"lovs": AWSJSON,
"extractionPrompt": "abc123",
"entityParameters": AWSJSON,
"entityStates": AWSJSON,
"workflowTriggers": AWSJSON,
"referentialConstraints": AWSJSON,
"detailEntities": AWSJSON
}
}
}
getEntityMetadatas
Response
Returns [EntityMetadata]
Arguments
| Name | Description |
|---|---|
tenantId - String!
|
Example
Query
query getEntityMetadatas($tenantId: String!) {
getEntityMetadatas(tenantId: $tenantId) {
entityName
attributes
IDGeneration
pkFormula
skFormula
pk1Formula
sk1Formula
pk2Formula
sk2Formula
pk3Formula
sk3Formula
pk4Formula
sk4Formula
pk5Formula
sk5Formula
pk6Formula
sk6Formula
pk7Formula
sk7Formula
pk8Formula
sk8Formula
pk9Formula
sk9Formula
pk10Formula
sk10Formula
formLayout
lovs
extractionPrompt
entityParameters
entityStates
workflowTriggers
referentialConstraints
detailEntities
}
}
Variables
{"tenantId": "xyz789"}
Response
{
"data": {
"getEntityMetadatas": [
{
"entityName": "abc123",
"attributes": AWSJSON,
"IDGeneration": AWSJSON,
"pkFormula": "xyz789",
"skFormula": "xyz789",
"pk1Formula": "xyz789",
"sk1Formula": "xyz789",
"pk2Formula": "abc123",
"sk2Formula": "abc123",
"pk3Formula": "abc123",
"sk3Formula": "abc123",
"pk4Formula": "xyz789",
"sk4Formula": "xyz789",
"pk5Formula": "xyz789",
"sk5Formula": "xyz789",
"pk6Formula": "xyz789",
"sk6Formula": "abc123",
"pk7Formula": "abc123",
"sk7Formula": "abc123",
"pk8Formula": "xyz789",
"sk8Formula": "abc123",
"pk9Formula": "xyz789",
"sk9Formula": "abc123",
"pk10Formula": "xyz789",
"sk10Formula": "abc123",
"formLayout": [AWSJSON],
"lovs": AWSJSON,
"extractionPrompt": "abc123",
"entityParameters": AWSJSON,
"entityStates": AWSJSON,
"workflowTriggers": AWSJSON,
"referentialConstraints": AWSJSON,
"detailEntities": AWSJSON
}
]
}
}
getPendingActivities
Response
Returns [PendingActivity]
Arguments
| Name | Description |
|---|---|
tenantId - String!
|
Example
Query
query getPendingActivities($tenantId: String!) {
getPendingActivities(tenantId: $tenantId) {
tenantId
activityId
inputValues
taskToken
}
}
Variables
{"tenantId": "xyz789"}
Response
{
"data": {
"getPendingActivities": [
{
"tenantId": "xyz789",
"activityId": "xyz789",
"inputValues": "xyz789",
"taskToken": "xyz789"
}
]
}
}
getReportTemplate
Response
Returns a ReportTemplate
Example
Query
query getReportTemplate(
$tenantId: String!,
$templateId: ID!
) {
getReportTemplate(
tenantId: $tenantId,
templateId: $templateId
) {
templateId
templateName
templateKey
tenantId
createdDate
metadata
}
}
Variables
{
"tenantId": "abc123",
"templateId": "4"
}
Response
{
"data": {
"getReportTemplate": {
"templateId": 4,
"templateName": "abc123",
"templateKey": "abc123",
"tenantId": "abc123",
"createdDate": "abc123",
"metadata": AWSJSON
}
}
}
listCounters
Example
Query
query listCounters($tenantId: String!) {
listCounters(tenantId: $tenantId) {
tenantId
counterName
currentValue
format
}
}
Variables
{"tenantId": "abc123"}
Response
{
"data": {
"listCounters": [
{
"tenantId": "xyz789",
"counterName": "abc123",
"currentValue": 123,
"format": "abc123"
}
]
}
}
listEntities
Response
Returns a ListEntitiesResponse
Example
Query
query listEntities(
$tenantId: String!,
$entityName: String!,
$filter: [EntityFilter],
$nextToken: String,
$limit: Int,
$requestedFields: [String],
$strictEntityName: Boolean,
$includeReferences: Boolean,
$includeDetails: Boolean,
$useGSI: Int
) {
listEntities(
tenantId: $tenantId,
entityName: $entityName,
filter: $filter,
nextToken: $nextToken,
limit: $limit,
requestedFields: $requestedFields,
strictEntityName: $strictEntityName,
includeReferences: $includeReferences,
includeDetails: $includeDetails,
useGSI: $useGSI
) {
success
message
entities {
...EntityFragment
}
nextToken
error
}
}
Variables
{
"tenantId": "xyz789",
"entityName": "abc123",
"filter": [EntityFilter],
"nextToken": "abc123",
"limit": 123,
"requestedFields": ["xyz789"],
"strictEntityName": false,
"includeReferences": false,
"includeDetails": true,
"useGSI": 123
}
Response
{
"data": {
"listEntities": {
"success": false,
"message": "xyz789",
"entities": [Entity],
"nextToken": "xyz789",
"error": "abc123"
}
}
}
listEntity
Response
Returns an Entity
Example
Query
query listEntity(
$tenantId: String!,
$entityName: String!,
$id: String!,
$includeReferences: Boolean,
$includeDetails: Boolean
) {
listEntity(
tenantId: $tenantId,
entityName: $entityName,
id: $id,
includeReferences: $includeReferences,
includeDetails: $includeDetails
) {
tenantId
entityName
id
data
linkedEntities
detailEntities
}
}
Variables
{
"tenantId": "abc123",
"entityName": "xyz789",
"id": "xyz789",
"includeReferences": false,
"includeDetails": true
}
Response
{
"data": {
"listEntity": {
"tenantId": "xyz789",
"entityName": "xyz789",
"id": "abc123",
"data": AWSJSON,
"linkedEntities": AWSJSON,
"detailEntities": AWSJSON
}
}
}
listGroupPolicies
Response
Returns [Policy!]!
Example
Query
query listGroupPolicies(
$tenantId: String!,
$groupName: String!
) {
listGroupPolicies(
tenantId: $tenantId,
groupName: $groupName
) {
policyId
entityName
entityId
policyTemplateId
principal {
...PrincipalFragment
}
tenantId
createdAt
resource
}
}
Variables
{
"tenantId": "abc123",
"groupName": "abc123"
}
Response
{
"data": {
"listGroupPolicies": [
{
"policyId": 4,
"entityName": "abc123",
"entityId": "xyz789",
"policyTemplateId": "abc123",
"principal": Principal,
"tenantId": "abc123",
"createdAt": "abc123",
"resource": AWSJSON
}
]
}
}
listGroups
Example
Query
query listGroups($tenantId: String!) {
listGroups(tenantId: $tenantId) {
groupName
createdAt
}
}
Variables
{"tenantId": "xyz789"}
Response
{
"data": {
"listGroups": [
{
"groupName": "xyz789",
"createdAt": AWSDateTime
}
]
}
}
listOppPositions
Response
Returns a ListEntitiesResponse
Example
Query
query listOppPositions(
$tenantId: String!,
$positionId: String!,
$nextToken: String,
$limit: Int
) {
listOppPositions(
tenantId: $tenantId,
positionId: $positionId,
nextToken: $nextToken,
limit: $limit
) {
success
message
entities {
...EntityFragment
}
nextToken
error
}
}
Variables
{
"tenantId": "abc123",
"positionId": "xyz789",
"nextToken": "abc123",
"limit": 987
}
Response
{
"data": {
"listOppPositions": {
"success": false,
"message": "abc123",
"entities": [Entity],
"nextToken": "xyz789",
"error": "xyz789"
}
}
}
listPolicies
Response
Returns [Policy!]!
Example
Query
query listPolicies(
$tenantId: String!,
$entityName: String!,
$entityId: String!
) {
listPolicies(
tenantId: $tenantId,
entityName: $entityName,
entityId: $entityId
) {
policyId
entityName
entityId
policyTemplateId
principal {
...PrincipalFragment
}
tenantId
createdAt
resource
}
}
Variables
{
"tenantId": "abc123",
"entityName": "xyz789",
"entityId": "abc123"
}
Response
{
"data": {
"listPolicies": [
{
"policyId": "4",
"entityName": "abc123",
"entityId": "abc123",
"policyTemplateId": "xyz789",
"principal": Principal,
"tenantId": "abc123",
"createdAt": "abc123",
"resource": AWSJSON
}
]
}
}
listPolicyTemplates
Response
Returns [PolicyTemplate!]!
Arguments
| Name | Description |
|---|---|
tenantId - String!
|
Example
Query
query listPolicyTemplates($tenantId: String!) {
listPolicyTemplates(tenantId: $tenantId) {
policyTemplateId
description
statement
createdAt
lastUpdatedAt
}
}
Variables
{"tenantId": "abc123"}
Response
{
"data": {
"listPolicyTemplates": [
{
"policyTemplateId": 4,
"description": "abc123",
"statement": "xyz789",
"createdAt": AWSDateTime,
"lastUpdatedAt": AWSDateTime
}
]
}
}
listReportTemplates
Response
Returns [ReportTemplate]
Arguments
| Name | Description |
|---|---|
tenantId - String!
|
Example
Query
query listReportTemplates($tenantId: String!) {
listReportTemplates(tenantId: $tenantId) {
templateId
templateName
templateKey
tenantId
createdDate
metadata
}
}
Variables
{"tenantId": "abc123"}
Response
{
"data": {
"listReportTemplates": [
{
"templateId": 4,
"templateName": "abc123",
"templateKey": "xyz789",
"tenantId": "xyz789",
"createdDate": "xyz789",
"metadata": AWSJSON
}
]
}
}
listUserPolicies
Description
Listing Policies by User/Group as principals
Response
Returns [Policy!]!
Example
Query
query listUserPolicies(
$tenantId: String!,
$email: String!
) {
listUserPolicies(
tenantId: $tenantId,
email: $email
) {
policyId
entityName
entityId
policyTemplateId
principal {
...PrincipalFragment
}
tenantId
createdAt
resource
}
}
Variables
{
"tenantId": "xyz789",
"email": "abc123"
}
Response
{
"data": {
"listUserPolicies": [
{
"policyId": 4,
"entityName": "abc123",
"entityId": "abc123",
"policyTemplateId": "xyz789",
"principal": Principal,
"tenantId": "xyz789",
"createdAt": "abc123",
"resource": AWSJSON
}
]
}
}
listUsers
Description
User/Group Listing Queries
Example
Query
query listUsers($tenantId: String!) {
listUsers(tenantId: $tenantId) {
email
status
enabled
createdAt
}
}
Variables
{"tenantId": "abc123"}
Response
{
"data": {
"listUsers": [
{
"email": "xyz789",
"status": "abc123",
"enabled": true,
"createdAt": AWSDateTime
}
]
}
}
listUsersInGroup
Example
Query
query listUsersInGroup(
$tenantId: String!,
$groupName: String!
) {
listUsersInGroup(
tenantId: $tenantId,
groupName: $groupName
) {
email
status
enabled
createdAt
}
}
Variables
{
"tenantId": "abc123",
"groupName": "abc123"
}
Response
{
"data": {
"listUsersInGroup": [
{
"email": "xyz789",
"status": "abc123",
"enabled": false,
"createdAt": AWSDateTime
}
]
}
}
Mutations
addPolicy
Description
AVP Related
Response
Returns a Policy!
Arguments
| Name | Description |
|---|---|
input - AddPolicyInput!
|
Example
Query
mutation addPolicy($input: AddPolicyInput!) {
addPolicy(input: $input) {
policyId
entityName
entityId
policyTemplateId
principal {
...PrincipalFragment
}
tenantId
createdAt
resource
}
}
Variables
{"input": AddPolicyInput}
Response
{
"data": {
"addPolicy": {
"policyId": "4",
"entityName": "xyz789",
"entityId": "xyz789",
"policyTemplateId": "abc123",
"principal": Principal,
"tenantId": "abc123",
"createdAt": "abc123",
"resource": AWSJSON
}
}
}
addUserToGroup
Response
Returns an OperationResponse
Example
Query
mutation addUserToGroup(
$tenantId: String!,
$email: [String]!,
$groupName: [String]!
) {
addUserToGroup(
tenantId: $tenantId,
email: $email,
groupName: $groupName
) {
success
message
}
}
Variables
{
"tenantId": "xyz789",
"email": ["abc123"],
"groupName": ["abc123"]
}
Response
{
"data": {
"addUserToGroup": {
"success": false,
"message": "xyz789"
}
}
}
convertEntity
Response
Returns an EntityResponse
Example
Query
mutation convertEntity(
$tenantId: String!,
$entityName: String!,
$id: String!,
$newEntityName: String!
) {
convertEntity(
tenantId: $tenantId,
entityName: $entityName,
id: $id,
newEntityName: $newEntityName
) {
success
message
executionId
data
tenantId
entityName
id
}
}
Variables
{
"tenantId": "abc123",
"entityName": "xyz789",
"id": "abc123",
"newEntityName": "xyz789"
}
Response
{
"data": {
"convertEntity": {
"success": false,
"message": "xyz789",
"executionId": 4,
"data": AWSJSON,
"tenantId": "xyz789",
"entityName": "abc123",
"id": "abc123"
}
}
}
createCounter
Response
Returns a Counter
Example
Query
mutation createCounter(
$tenantId: String!,
$counterName: String!,
$startValue: Int!,
$format: String
) {
createCounter(
tenantId: $tenantId,
counterName: $counterName,
startValue: $startValue,
format: $format
) {
tenantId
counterName
currentValue
format
}
}
Variables
{
"tenantId": "abc123",
"counterName": "abc123",
"startValue": 987,
"format": "xyz789"
}
Response
{
"data": {
"createCounter": {
"tenantId": "abc123",
"counterName": "abc123",
"currentValue": 123,
"format": "abc123"
}
}
}
createEntity
Response
Returns an EntityResponse
Example
Query
mutation createEntity(
$tenantId: String!,
$entityName: String!,
$id: String,
$data: AWSJSON!,
$overwriteIfExists: Boolean
) {
createEntity(
tenantId: $tenantId,
entityName: $entityName,
id: $id,
data: $data,
overwriteIfExists: $overwriteIfExists
) {
success
message
executionId
data
tenantId
entityName
id
}
}
Variables
{
"tenantId": "xyz789",
"entityName": "xyz789",
"id": "abc123",
"data": AWSJSON,
"overwriteIfExists": true
}
Response
{
"data": {
"createEntity": {
"success": false,
"message": "xyz789",
"executionId": "4",
"data": AWSJSON,
"tenantId": "xyz789",
"entityName": "xyz789",
"id": "xyz789"
}
}
}
createEntityMetadata
Response
Returns an EntityMetadata
Arguments
| Name | Description |
|---|---|
tenantId - String!
|
|
entityMetadataInput - EntityMetadataInput!
|
Example
Query
mutation createEntityMetadata(
$tenantId: String!,
$entityMetadataInput: EntityMetadataInput!
) {
createEntityMetadata(
tenantId: $tenantId,
entityMetadataInput: $entityMetadataInput
) {
entityName
attributes
IDGeneration
pkFormula
skFormula
pk1Formula
sk1Formula
pk2Formula
sk2Formula
pk3Formula
sk3Formula
pk4Formula
sk4Formula
pk5Formula
sk5Formula
pk6Formula
sk6Formula
pk7Formula
sk7Formula
pk8Formula
sk8Formula
pk9Formula
sk9Formula
pk10Formula
sk10Formula
formLayout
lovs
extractionPrompt
entityParameters
entityStates
workflowTriggers
referentialConstraints
detailEntities
}
}
Variables
{
"tenantId": "xyz789",
"entityMetadataInput": EntityMetadataInput
}
Response
{
"data": {
"createEntityMetadata": {
"entityName": "xyz789",
"attributes": AWSJSON,
"IDGeneration": AWSJSON,
"pkFormula": "xyz789",
"skFormula": "xyz789",
"pk1Formula": "abc123",
"sk1Formula": "xyz789",
"pk2Formula": "abc123",
"sk2Formula": "abc123",
"pk3Formula": "xyz789",
"sk3Formula": "xyz789",
"pk4Formula": "xyz789",
"sk4Formula": "abc123",
"pk5Formula": "abc123",
"sk5Formula": "xyz789",
"pk6Formula": "abc123",
"sk6Formula": "xyz789",
"pk7Formula": "xyz789",
"sk7Formula": "abc123",
"pk8Formula": "abc123",
"sk8Formula": "xyz789",
"pk9Formula": "xyz789",
"sk9Formula": "abc123",
"pk10Formula": "abc123",
"sk10Formula": "abc123",
"formLayout": [AWSJSON],
"lovs": AWSJSON,
"extractionPrompt": "xyz789",
"entityParameters": AWSJSON,
"entityStates": AWSJSON,
"workflowTriggers": AWSJSON,
"referentialConstraints": AWSJSON,
"detailEntities": AWSJSON
}
}
}
createGroup
Response
Returns an OperationResponse
Example
Query
mutation createGroup(
$tenantId: String!,
$groupName: String!
) {
createGroup(
tenantId: $tenantId,
groupName: $groupName
) {
success
message
}
}
Variables
{
"tenantId": "abc123",
"groupName": "xyz789"
}
Response
{
"data": {
"createGroup": {
"success": true,
"message": "xyz789"
}
}
}
createJourney
Response
Returns a Journey!
Example
Query
mutation createJourney(
$tenantId: String!,
$id: String!,
$linkingId: ID!,
$journeyBegin: String!,
$journeyEnd: String!,
$whSubDepId: ID!,
$pointDestinationId: ID!
) {
createJourney(
tenantId: $tenantId,
id: $id,
linkingId: $linkingId,
journeyBegin: $journeyBegin,
journeyEnd: $journeyEnd,
whSubDepId: $whSubDepId,
pointDestinationId: $pointDestinationId
) {
id
linkingId
status
data
}
}
Variables
{
"tenantId": "xyz789",
"id": "xyz789",
"linkingId": "4",
"journeyBegin": "xyz789",
"journeyEnd": "abc123",
"whSubDepId": "4",
"pointDestinationId": "4"
}
Response
{
"data": {
"createJourney": {
"id": 4,
"linkingId": "4",
"status": "CREATED",
"data": AWSJSON
}
}
}
createReportTemplate
Response
Returns a ReportTemplateResponse
Arguments
| Name | Description |
|---|---|
input - CreateReportTemplateInput!
|
Example
Query
mutation createReportTemplate($input: CreateReportTemplateInput!) {
createReportTemplate(input: $input) {
success
message
templateId
templateName
templateKey
tenantId
createdDate
metadata
}
}
Variables
{"input": CreateReportTemplateInput}
Response
{
"data": {
"createReportTemplate": {
"success": true,
"message": "abc123",
"templateId": "4",
"templateName": "xyz789",
"templateKey": "xyz789",
"tenantId": "abc123",
"createdDate": "abc123",
"metadata": AWSJSON
}
}
}
createUser
Description
User/Group Management Mutations
Response
Returns an OperationResponse
Example
Query
mutation createUser(
$tenantId: String!,
$email: String!
) {
createUser(
tenantId: $tenantId,
email: $email
) {
success
message
}
}
Variables
{
"tenantId": "abc123",
"email": "xyz789"
}
Response
{
"data": {
"createUser": {
"success": true,
"message": "abc123"
}
}
}
createWorkflow
Response
Returns a WorkflowResponse
Arguments
| Name | Description |
|---|---|
input - CreateWorkflowInput!
|
Example
Query
mutation createWorkflow($input: CreateWorkflowInput!) {
createWorkflow(input: $input) {
success
message
id
workflow {
...WorkflowFragment
}
}
}
Variables
{"input": CreateWorkflowInput}
Response
{
"data": {
"createWorkflow": {
"success": true,
"message": "xyz789",
"id": 4,
"workflow": Workflow
}
}
}
deleteCounter
Example
Query
mutation deleteCounter(
$tenantId: String!,
$counterName: String!
) {
deleteCounter(
tenantId: $tenantId,
counterName: $counterName
)
}
Variables
{
"tenantId": "abc123",
"counterName": "xyz789"
}
Response
{"data": {"deleteCounter": true}}
deleteEntity
Response
Returns an EntityResponse
Example
Query
mutation deleteEntity(
$tenantId: String!,
$entityName: String!,
$id: String!
) {
deleteEntity(
tenantId: $tenantId,
entityName: $entityName,
id: $id
) {
success
message
executionId
data
tenantId
entityName
id
}
}
Variables
{
"tenantId": "xyz789",
"entityName": "xyz789",
"id": "abc123"
}
Response
{
"data": {
"deleteEntity": {
"success": false,
"message": "abc123",
"executionId": 4,
"data": AWSJSON,
"tenantId": "xyz789",
"entityName": "abc123",
"id": "abc123"
}
}
}
deleteGroup
Response
Returns an OperationResponse
Example
Query
mutation deleteGroup(
$tenantId: String!,
$groupName: String!
) {
deleteGroup(
tenantId: $tenantId,
groupName: $groupName
) {
success
message
}
}
Variables
{
"tenantId": "abc123",
"groupName": "xyz789"
}
Response
{
"data": {
"deleteGroup": {
"success": true,
"message": "xyz789"
}
}
}
deleteJourney
Example
Query
mutation deleteJourney(
$tenantId: String!,
$id: String!
) {
deleteJourney(
tenantId: $tenantId,
id: $id
) {
id
linkingId
status
data
}
}
Variables
{
"tenantId": "xyz789",
"id": "xyz789"
}
Response
{
"data": {
"deleteJourney": {
"id": "4",
"linkingId": "4",
"status": "CREATED",
"data": AWSJSON
}
}
}
deleteUser
Response
Returns an OperationResponse
Example
Query
mutation deleteUser(
$tenantId: String!,
$email: String!
) {
deleteUser(
tenantId: $tenantId,
email: $email
) {
success
message
}
}
Variables
{
"tenantId": "xyz789",
"email": "abc123"
}
Response
{
"data": {
"deleteUser": {
"success": true,
"message": "abc123"
}
}
}
deleteUserFromGroup
Response
Returns an OperationResponse
Example
Query
mutation deleteUserFromGroup(
$tenantId: String!,
$email: String!,
$groupName: String!
) {
deleteUserFromGroup(
tenantId: $tenantId,
email: $email,
groupName: $groupName
) {
success
message
}
}
Variables
{
"tenantId": "xyz789",
"email": "abc123",
"groupName": "xyz789"
}
Response
{
"data": {
"deleteUserFromGroup": {
"success": true,
"message": "abc123"
}
}
}
deleteWorkflow
Response
Returns a WorkflowResponse
Example
Query
mutation deleteWorkflow(
$tenantId: String!,
$id: ID!,
$name: String!
) {
deleteWorkflow(
tenantId: $tenantId,
id: $id,
name: $name
) {
success
message
id
workflow {
...WorkflowFragment
}
}
}
Variables
{
"tenantId": "xyz789",
"id": "4",
"name": "xyz789"
}
Response
{
"data": {
"deleteWorkflow": {
"success": false,
"message": "xyz789",
"id": 4,
"workflow": Workflow
}
}
}
disableUser
Response
Returns an OperationResponse
Example
Query
mutation disableUser(
$tenantId: String!,
$email: String!
) {
disableUser(
tenantId: $tenantId,
email: $email
) {
success
message
}
}
Variables
{
"tenantId": "abc123",
"email": "abc123"
}
Response
{
"data": {
"disableUser": {
"success": false,
"message": "abc123"
}
}
}
enableUser
Response
Returns an OperationResponse
Example
Query
mutation enableUser(
$tenantId: String!,
$email: String!
) {
enableUser(
tenantId: $tenantId,
email: $email
) {
success
message
}
}
Variables
{
"tenantId": "xyz789",
"email": "abc123"
}
Response
{
"data": {
"enableUser": {
"success": true,
"message": "xyz789"
}
}
}
extractDocumentData
Response
Returns an ExtractDocumentJobResponse
Arguments
| Name | Description |
|---|---|
input - ExtractDocumentDataInput!
|
Example
Query
mutation extractDocumentData($input: ExtractDocumentDataInput!) {
extractDocumentData(input: $input) {
status
message
executionArn
}
}
Variables
{"input": ExtractDocumentDataInput}
Response
{
"data": {
"extractDocumentData": {
"status": "xyz789",
"message": "xyz789",
"executionArn": "xyz789"
}
}
}
fetchActivity
Response
Returns a FetchActivityResponse
Arguments
| Name | Description |
|---|---|
tenantId - String!
|
Example
Query
mutation fetchActivity($tenantId: String!) {
fetchActivity(tenantId: $tenantId) {
success
message
tenantId
userId
assignedActivity {
...ActivityFragment
}
}
}
Variables
{"tenantId": "abc123"}
Response
{
"data": {
"fetchActivity": {
"success": false,
"message": "abc123",
"tenantId": "xyz789",
"userId": "abc123",
"assignedActivity": Activity
}
}
}
fetchCounterNext
Example
Query
mutation fetchCounterNext(
$tenantId: String!,
$counterName: String!
) {
fetchCounterNext(
tenantId: $tenantId,
counterName: $counterName
) {
tenantId
counterName
currentValue
format
}
}
Variables
{
"tenantId": "xyz789",
"counterName": "xyz789"
}
Response
{
"data": {
"fetchCounterNext": {
"tenantId": "abc123",
"counterName": "abc123",
"currentValue": 987,
"format": "abc123"
}
}
}
generatePresignedS3Url
Response
Returns a PresignedUrlResponse
Example
Query
mutation generatePresignedS3Url(
$folder: String!,
$fileName: String!,
$operation: String!,
$tenantId: String!
) {
generatePresignedS3Url(
folder: $folder,
fileName: $fileName,
operation: $operation,
tenantId: $tenantId
) {
presignedUrl
fileKey
}
}
Variables
{
"folder": "abc123",
"fileName": "xyz789",
"operation": "xyz789",
"tenantId": "xyz789"
}
Response
{
"data": {
"generatePresignedS3Url": {
"presignedUrl": "xyz789",
"fileKey": "xyz789"
}
}
}
generateReport
Response
Returns a ReportStatus
Arguments
| Name | Description |
|---|---|
input - GenerateReportInput!
|
Example
Query
mutation generateReport($input: GenerateReportInput!) {
generateReport(input: $input) {
success
message
reportUrl
reportKey
}
}
Variables
{"input": GenerateReportInput}
Response
{
"data": {
"generateReport": {
"success": true,
"message": "abc123",
"reportUrl": "abc123",
"reportKey": "abc123"
}
}
}
linkPositions
Response
Returns a Linking!
Arguments
| Name | Description |
|---|---|
input - LinkPositionsInput!
|
Example
Query
mutation linkPositions($input: LinkPositionsInput!) {
linkPositions(input: $input) {
success
message
executionId
linkingId
data
tenantId
}
}
Variables
{"input": LinkPositionsInput}
Response
{
"data": {
"linkPositions": {
"success": true,
"message": "xyz789",
"executionId": "abc123",
"linkingId": "4",
"data": AWSJSON,
"tenantId": "abc123"
}
}
}
processActivity
Response
Returns a String
Example
Query
mutation processActivity(
$tenantId: String!,
$activityId: String!,
$outcome: String!
) {
processActivity(
tenantId: $tenantId,
activityId: $activityId,
outcome: $outcome
)
}
Variables
{
"tenantId": "xyz789",
"activityId": "xyz789",
"outcome": "abc123"
}
Response
{"data": {"processActivity": "abc123"}}
removePolicy
Example
Query
mutation removePolicy(
$tenantId: String!,
$policyId: ID!
) {
removePolicy(
tenantId: $tenantId,
policyId: $policyId
)
}
Variables
{
"tenantId": "xyz789",
"policyId": "4"
}
Response
{"data": {"removePolicy": true}}
resetPassword
Response
Returns an OperationResponse
Example
Query
mutation resetPassword(
$tenantId: String!,
$email: String!
) {
resetPassword(
tenantId: $tenantId,
email: $email
) {
success
message
}
}
Variables
{
"tenantId": "xyz789",
"email": "xyz789"
}
Response
{
"data": {
"resetPassword": {
"success": true,
"message": "abc123"
}
}
}
startJourney
Example
Query
mutation startJourney(
$tenantId: String!,
$id: String!
) {
startJourney(
tenantId: $tenantId,
id: $id
)
}
Variables
{
"tenantId": "abc123",
"id": "xyz789"
}
Response
{"data": {"startJourney": "abc123"}}
startWorkflow
Response
Returns a WorkflowResponse
Example
Query
mutation startWorkflow(
$tenantId: String!,
$id: ID!,
$entityName: String,
$entityId: String
) {
startWorkflow(
tenantId: $tenantId,
id: $id,
entityName: $entityName,
entityId: $entityId
) {
success
message
id
workflow {
...WorkflowFragment
}
}
}
Variables
{
"tenantId": "xyz789",
"id": 4,
"entityName": "abc123",
"entityId": "abc123"
}
Response
{
"data": {
"startWorkflow": {
"success": false,
"message": "abc123",
"id": "4",
"workflow": Workflow
}
}
}
unlinkPositions
Example
Query
mutation unlinkPositions(
$tenantId: String!,
$id: String!
) {
unlinkPositions(
tenantId: $tenantId,
id: $id
) {
success
message
executionId
linkingId
data
tenantId
}
}
Variables
{
"tenantId": "abc123",
"id": "xyz789"
}
Response
{
"data": {
"unlinkPositions": {
"success": true,
"message": "xyz789",
"executionId": "xyz789",
"linkingId": "4",
"data": AWSJSON,
"tenantId": "xyz789"
}
}
}
updateEntity
Response
Returns an EntityResponse
Example
Query
mutation updateEntity(
$tenantId: String!,
$entityName: String!,
$id: String!,
$data: AWSJSON!,
$partialUpdate: Boolean
) {
updateEntity(
tenantId: $tenantId,
entityName: $entityName,
id: $id,
data: $data,
partialUpdate: $partialUpdate
) {
success
message
executionId
data
tenantId
entityName
id
}
}
Variables
{
"tenantId": "xyz789",
"entityName": "xyz789",
"id": "abc123",
"data": AWSJSON,
"partialUpdate": true
}
Response
{
"data": {
"updateEntity": {
"success": true,
"message": "xyz789",
"executionId": "4",
"data": AWSJSON,
"tenantId": "xyz789",
"entityName": "xyz789",
"id": "abc123"
}
}
}
updateReportTemplate
Response
Returns a ReportTemplateResponse
Arguments
| Name | Description |
|---|---|
input - UpdateReportTemplateInput!
|
Example
Query
mutation updateReportTemplate($input: UpdateReportTemplateInput!) {
updateReportTemplate(input: $input) {
success
message
templateId
templateName
templateKey
tenantId
createdDate
metadata
}
}
Variables
{"input": UpdateReportTemplateInput}
Response
{
"data": {
"updateReportTemplate": {
"success": false,
"message": "abc123",
"templateId": 4,
"templateName": "xyz789",
"templateKey": "abc123",
"tenantId": "xyz789",
"createdDate": "xyz789",
"metadata": AWSJSON
}
}
}
updateWorkflow
Response
Returns a WorkflowResponse
Arguments
| Name | Description |
|---|---|
input - UpdateWorkflowInput!
|
Example
Query
mutation updateWorkflow($input: UpdateWorkflowInput!) {
updateWorkflow(input: $input) {
success
message
id
workflow {
...WorkflowFragment
}
}
}
Variables
{"input": UpdateWorkflowInput}
Response
{
"data": {
"updateWorkflow": {
"success": true,
"message": "abc123",
"id": "4",
"workflow": Workflow
}
}
}
Subscriptions
onUpdateEntity
Response
Returns an EntityResponse
Example
Query
subscription onUpdateEntity(
$tenantId: String!,
$entityName: String!,
$id: String
) {
onUpdateEntity(
tenantId: $tenantId,
entityName: $entityName,
id: $id
) {
success
message
executionId
data
tenantId
entityName
id
}
}
Variables
{
"tenantId": "xyz789",
"entityName": "xyz789",
"id": "abc123"
}
Response
{
"data": {
"onUpdateEntity": {
"success": true,
"message": "xyz789",
"executionId": 4,
"data": AWSJSON,
"tenantId": "xyz789",
"entityName": "xyz789",
"id": "abc123"
}
}
}
Types
AWSDateTime
Description
The AWSDateTime scalar type provided by AWS AppSync, represents a valid extended ISO 8601 DateTime string. In other words, this scalar type accepts datetime strings of the form YYYY-MM-DDThh:mm:ss.SSSZ. The scalar can also accept "negative years" of the form -YYYY which correspond to years before 0000. For example, "-2017-01-01T00:00Z" and "-9999-01-01T00:00Z" are both valid datetime strings. The field after the two digit seconds field is a nanoseconds field. It can accept between 1 and 9 digits. So, for example, "1970-01-01T12:00:00.2Z", "1970-01-01T12:00:00.277Z" and "1970-01-01T12:00:00.123456789Z" are all valid datetime strings. The seconds and nanoseconds fields are optional (the seconds field must be specified if the nanoseconds field is to be used). The time zone offset is compulsory for this scalar. The time zone offset must either be Z (representing the UTC time zone) or be in the format ±hh:mm:ss. The seconds field in the timezone offset will be considered valid even though it is not part of the ISO 8601 standard.
Example
AWSDateTime
AWSJSON
Description
The AWSJSON scalar type provided by AWS AppSync, represents a JSON string that complies with RFC 8259. Maps like "{\"upvotes\": 10}", lists like "[1,2,3]", and scalar values like "\"AWSJSON example string\"", "1", and "true" are accepted as valid JSON and will automatically be parsed and loaded in the resolver mapping templates as Maps, Lists, or Scalar values rather than as the literal input strings. Invalid JSON strings like "{a: 1}", "{'a': 1}" and "Unquoted string" will throw GraphQL validation errors.
Example
AWSJSON
Activity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
workflowId - String
|
|
arn - String!
|
|
priority - String!
|
|
type - String
|
|
status - String!
|
|
relatedEntityName - String!
|
|
relatedEntityId - String!
|
|
assignedTo - String
|
|
assignmentMethod - String
|
|
assignedBy - String
|
|
subDepartmentId - String
|
|
outcome - String
|
|
feedback - String
|
|
duration - Int
|
|
createdAt - String!
|
|
updatedAt - String
|
|
activityToken - String
|
|
completedAt - String
|
|
activityCategory - String
|
Example
{
"id": 4,
"workflowId": "abc123",
"arn": "abc123",
"priority": "abc123",
"type": "abc123",
"status": "abc123",
"relatedEntityName": "abc123",
"relatedEntityId": "xyz789",
"assignedTo": "abc123",
"assignmentMethod": "xyz789",
"assignedBy": "xyz789",
"subDepartmentId": "xyz789",
"outcome": "xyz789",
"feedback": "abc123",
"duration": 987,
"createdAt": "xyz789",
"updatedAt": "abc123",
"activityToken": "xyz789",
"completedAt": "xyz789",
"activityCategory": "abc123"
}
AddPolicyInput
Fields
| Input Field | Description |
|---|---|
tenantId - String!
|
|
entityName - String!
|
|
entityId - String!
|
|
policyTemplateId - String!
|
|
principal - PrincipalInput!
|
Example
{
"tenantId": "abc123",
"entityName": "xyz789",
"entityId": "abc123",
"policyTemplateId": "xyz789",
"principal": PrincipalInput
}
AuthorizationInput
AuthorizationRequest
AuthorizationResult
BatchAuthorizationRequest
Fields
| Input Field | Description |
|---|---|
tenantId - String!
|
|
requests - [AuthorizationInput!]!
|
Example
{
"tenantId": "abc123",
"requests": [AuthorizationInput]
}
Boolean
Description
Built-in Boolean
Example
true
Counter
CreateReportTemplateInput
CreateWorkflowInput
Fields
| Input Field | Description |
|---|---|
tenantId - String!
|
|
name - String!
|
|
subDepartmentId - ID
|
|
subDepartmentName - String
|
|
type - WorkflowType!
|
|
graph - AWSJSON!
|
|
status - WorkflowStatus!
|
Example
{
"tenantId": "abc123",
"name": "abc123",
"subDepartmentId": 4,
"subDepartmentName": "abc123",
"type": "APPROVAL",
"graph": AWSJSON,
"status": "DRAFT"
}
DestinationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"POSITION"
Entity
EntityFilter
Fields
| Input Field | Description |
|---|---|
field - String!
|
|
operator - FilterOperator!
|
|
value - String!
|
Example
{
"field": "abc123",
"operator": "EQ",
"value": "xyz789"
}
EntityMetadata
Fields
| Field Name | Description |
|---|---|
entityName - String!
|
|
attributes - AWSJSON!
|
|
IDGeneration - AWSJSON!
|
|
pkFormula - String
|
|
skFormula - String
|
|
pk1Formula - String
|
|
sk1Formula - String
|
|
pk2Formula - String
|
|
sk2Formula - String
|
|
pk3Formula - String
|
|
sk3Formula - String
|
|
pk4Formula - String
|
|
sk4Formula - String
|
|
pk5Formula - String
|
|
sk5Formula - String
|
|
pk6Formula - String
|
|
sk6Formula - String
|
|
pk7Formula - String
|
|
sk7Formula - String
|
|
pk8Formula - String
|
|
sk8Formula - String
|
|
pk9Formula - String
|
|
sk9Formula - String
|
|
pk10Formula - String
|
|
sk10Formula - String
|
|
formLayout - [AWSJSON]
|
|
lovs - AWSJSON
|
|
extractionPrompt - String
|
|
entityParameters - AWSJSON
|
|
entityStates - AWSJSON
|
|
workflowTriggers - AWSJSON
|
|
referentialConstraints - AWSJSON
|
|
detailEntities - AWSJSON
|
Example
{
"entityName": "abc123",
"attributes": AWSJSON,
"IDGeneration": AWSJSON,
"pkFormula": "abc123",
"skFormula": "abc123",
"pk1Formula": "xyz789",
"sk1Formula": "abc123",
"pk2Formula": "xyz789",
"sk2Formula": "abc123",
"pk3Formula": "abc123",
"sk3Formula": "xyz789",
"pk4Formula": "abc123",
"sk4Formula": "xyz789",
"pk5Formula": "xyz789",
"sk5Formula": "xyz789",
"pk6Formula": "xyz789",
"sk6Formula": "xyz789",
"pk7Formula": "xyz789",
"sk7Formula": "xyz789",
"pk8Formula": "xyz789",
"sk8Formula": "xyz789",
"pk9Formula": "xyz789",
"sk9Formula": "abc123",
"pk10Formula": "xyz789",
"sk10Formula": "xyz789",
"formLayout": [AWSJSON],
"lovs": AWSJSON,
"extractionPrompt": "xyz789",
"entityParameters": AWSJSON,
"entityStates": AWSJSON,
"workflowTriggers": AWSJSON,
"referentialConstraints": AWSJSON,
"detailEntities": AWSJSON
}
EntityMetadataInput
Fields
| Input Field | Description |
|---|---|
entityName - String!
|
|
attributes - AWSJSON!
|
|
IDGeneration - AWSJSON!
|
|
pkFormula - String
|
|
skFormula - String
|
|
pk1Formula - String
|
|
sk1Formula - String
|
|
pk2Formula - String
|
|
sk2Formula - String
|
|
pk3Formula - String
|
|
sk3Formula - String
|
|
pk4Formula - String
|
|
sk4Formula - String
|
|
pk5Formula - String
|
|
sk5Formula - String
|
|
pk6Formula - String
|
|
sk6Formula - String
|
|
pk7Formula - String
|
|
sk7Formula - String
|
|
pk8Formula - String
|
|
sk8Formula - String
|
|
pk9Formula - String
|
|
sk9Formula - String
|
|
pk10Formula - String
|
|
sk10Formula - String
|
|
formLayout - [AWSJSON]
|
|
lovs - AWSJSON
|
|
extractionPrompt - String
|
|
entityParameters - AWSJSON
|
|
entityStates - AWSJSON
|
|
workflowTriggers - AWSJSON
|
|
referentialConstraints - AWSJSON
|
|
detailEntities - AWSJSON
|
Example
{
"entityName": "xyz789",
"attributes": AWSJSON,
"IDGeneration": AWSJSON,
"pkFormula": "xyz789",
"skFormula": "abc123",
"pk1Formula": "xyz789",
"sk1Formula": "abc123",
"pk2Formula": "xyz789",
"sk2Formula": "xyz789",
"pk3Formula": "xyz789",
"sk3Formula": "abc123",
"pk4Formula": "abc123",
"sk4Formula": "xyz789",
"pk5Formula": "abc123",
"sk5Formula": "xyz789",
"pk6Formula": "xyz789",
"sk6Formula": "abc123",
"pk7Formula": "abc123",
"sk7Formula": "abc123",
"pk8Formula": "xyz789",
"sk8Formula": "xyz789",
"pk9Formula": "xyz789",
"sk9Formula": "abc123",
"pk10Formula": "xyz789",
"sk10Formula": "abc123",
"formLayout": [AWSJSON],
"lovs": AWSJSON,
"extractionPrompt": "abc123",
"entityParameters": AWSJSON,
"entityStates": AWSJSON,
"workflowTriggers": AWSJSON,
"referentialConstraints": AWSJSON,
"detailEntities": AWSJSON
}
EntityResponse
ExtractDocumentDataInput
Example
{
"tenantId": "abc123",
"documentKey": "abc123",
"entityNames": ["xyz789"],
"bedrockModelId": "xyz789",
"prompt": "abc123",
"callModelWithDoc": true
}
ExtractDocumentJobResponse
FetchActivityResponse
FilterOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQ"
Float
Description
Built-in Float
Example
123.45
GenerateReportInput
Group
Fields
| Field Name | Description |
|---|---|
groupName - String!
|
|
createdAt - AWSDateTime
|
Example
{
"groupName": "abc123",
"createdAt": AWSDateTime
}
ID
Description
Built-in ID
Example
"4"
Int
Description
Built-in Int
Example
987
Journey
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
linkingId - ID!
|
|
status - JourneyStatus!
|
|
data - AWSJSON
|
Example
{
"id": "4",
"linkingId": 4,
"status": "CREATED",
"data": AWSJSON
}
JourneyStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATED"
LinkPositionsInput
Example
{
"linkingId": 4,
"tenantId": "xyz789",
"sourcePositionId": "4",
"destinationId": "4",
"destinationType": "POSITION",
"subDepartmentId": "4",
"quantity": 123.45
}
Linking
ListEntitiesResponse
OperationResponse
PendingActivity
Policy
Example
{
"policyId": "4",
"entityName": "xyz789",
"entityId": "abc123",
"policyTemplateId": "abc123",
"principal": Principal,
"tenantId": "abc123",
"createdAt": "xyz789",
"resource": AWSJSON
}
PolicyTemplate
Fields
| Field Name | Description |
|---|---|
policyTemplateId - ID!
|
|
description - String
|
|
statement - String
|
|
createdAt - AWSDateTime!
|
|
lastUpdatedAt - AWSDateTime
|
Example
{
"policyTemplateId": 4,
"description": "abc123",
"statement": "abc123",
"createdAt": AWSDateTime,
"lastUpdatedAt": AWSDateTime
}
PresignedUrlResponse
Principal
PrincipalInput
ReportStatus
ReportTemplate
ReportTemplateResponse
Example
{
"success": false,
"message": "xyz789",
"templateId": 4,
"templateName": "xyz789",
"templateKey": "xyz789",
"tenantId": "xyz789",
"createdDate": "xyz789",
"metadata": AWSJSON
}
String
Description
Built-in String
Example
"xyz789"
UpdateReportTemplateInput
UpdateWorkflowInput
Fields
| Input Field | Description |
|---|---|
tenantId - String!
|
|
id - ID!
|
|
name - String
|
|
subDepartmentId - ID
|
|
subDepartmentName - String
|
|
type - WorkflowType
|
|
graph - AWSJSON
|
|
status - WorkflowStatus
|
Example
{
"tenantId": "xyz789",
"id": 4,
"name": "abc123",
"subDepartmentId": "4",
"subDepartmentName": "xyz789",
"type": "APPROVAL",
"graph": AWSJSON,
"status": "DRAFT"
}
User
Description
New Types for listing Users and Groups
Fields
| Field Name | Description |
|---|---|
email - String!
|
|
status - String
|
|
enabled - Boolean
|
|
createdAt - AWSDateTime
|
Example
{
"email": "xyz789",
"status": "abc123",
"enabled": false,
"createdAt": AWSDateTime
}
Workflow
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
subDepartmentId - ID!
|
|
subDepartmentName - String!
|
|
type - WorkflowType!
|
|
graph - String!
|
|
status - WorkflowStatus!
|
|
stepFunctionAsl - String
|
|
stepFunctionArn - String!
|
|
createdAt - AWSDateTime
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": 4,
"name": "abc123",
"subDepartmentId": "4",
"subDepartmentName": "xyz789",
"type": "APPROVAL",
"graph": "xyz789",
"status": "DRAFT",
"stepFunctionAsl": "xyz789",
"stepFunctionArn": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
WorkflowResponse
WorkflowStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DRAFT"
WorkflowType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"APPROVAL"