{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/BasicFlowDTO",
"title": "BasicFlowDTO",
"type": "object",
"properties": {
"assignedRS": {
"uniqueItems": true,
"type": "array",
"description": "Assigned Routing Strategy",
"example": [
"rs-id1"
],
"items": {
"type": "string"
}
},
"createdBy": {
"type": "string",
"description": "Email of the account which created the flow",
"example": "[email protected]"
},
"createdDate": {
"type": "string",
"description": "Date of creation of the flow",
"example": "2024-02-07T14:10:50.663Z",
"format": "date-time"
},
"description": {
"type": "string",
"description": "Description of the flow",
"example": "This flow is updated with the 'Live' tag"
},
"flowType": {
"type": "string",
"description": "Flow Type (FLOW/SUBFLOW). Default value is FLOW",
"example": "FLOW"
},
"id": {
"type": "string",
"description": "Flow/Subflow ID",
"example": "65c28d9db2a2375974066579"
},
"lastModifiedBy": {
"type": "string",
"description": "Email of the account which modified the flow last",
"example": "[email protected]"
},
"lastModifiedDate": {
"type": "string",
"description": "Date the flow object is last modified",
"example": "2024-02-07T14:10:50.663Z",
"format": "date-time"
},
"lockedAt": {
"type": "string",
"description": "Moment at which a user began editing the flow and locked the flow for everyone else",
"example": "2024-02-07T14:10:50.663Z",
"format": "date-time"
},
"lockedBy": {
"type": "string",
"description": "Email of the account which is currently editing the flow",
"example": "[email protected]"
},
"name": {
"type": "string",
"description": "Name of the Flow",
"example": "TestFlow"
},
"orgId": {
"type": "string",
"description": "Organization ID",
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
"status": {
"type": "string",
"description": "Indicates if this flow has ever been published - is one of 'Draft' or 'Published'",
"example": "Draft"
},
"tagHistories": {
"type": "object",
"description": "Histories of the tags. Tracks how the tags have been assigned to versions chronologically",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowProgressionRes"
}
},
"example": {
"Latest": [
{
"fvId": "63e3fcb0b57f601a2ad62db4",
"fvName": "HttpTraceTest",
"forkFrom": "63e3fcb0b57f601a2ad62db4"
}
]
}
},
"tags": {
"type": "array",
"description": "Tags used by the flow",
"items": {
"$ref": "#/components/schemas/FlowTagRes"
}
},
"version": {
"type": "integer",
"description": "Version Number",
"format": "int32",
"example": 1
}
}
}