Crego APIs
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
APIs DocHome Page
Web Apps
  • Jupiter
  • Venus
  1. Design
  • Back to home
  • Flow
  • Design
    • Create Design
      POST
    • List Designs
      GET
    • Update Design
      PUT
    • Get Design
      GET
    • Mark as Current Design
      PUT
    • Duplicate Design
      POST
    • Get Expanded Design
      GET
    • Graph Validation
      GET
  • Runner
    • Create Runner
      POST
    • Execute Runner
      POST
    • Get Runner
      GET
    • List Runners
      GET
    • Runner Callback Handler
      POST
    • Runner activity
      GET
    • Runner Store
      GET
    • Update Runner design
      PUT
    • Update Store
      PUT
    • No Auth Runner Flow info
      GET
    • Parse Template
      POST
    • Get Current Nodes
      GET
  • Customer Auth
    • Refresh Token
      POST
    • Send OTP
      POST
    • Verify OTP
      POST
    • Auth Ping
      GET
    • Exchange Token
      POST
  • Utility
    • Get Schema
      GET
  • Warehouse
  • Store
    • Get Store
    • List Store
    • Create Store
  • Document
    • Create Document
    • Get Storage Document
    • Add files to document
    • Download files
  1. Design

Update Design

Developing
preprod
https://preprod.api.crego.io
preprod
https://preprod.api.crego.io
PUT
/v1/rego/designs/{id}/
Last modified:2024-11-25 17:35:50

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required
Body Params application/json
secret_id
string <uuid>
required
graph
object 
Flow Graph
required
Graph structure defining the nodes and edges of the flow.
nodes
array[object (Base Node) {5}] 
Nodes
required
List of nodes in the graph. Each node must be a non-empty string.
Examples:
node1node2node3
edges
$ref(#/definitions/4291925)[]
Edges
optional
Connections between nodes in the graph. Each edge must be a non-empty string.
Examples:
edge1edge2edge3
Could not resolve '#/definitions/4291925'
start_node
string 
Start Node
required
Default starting node in the graph.
Example:
node1
store_schema
object 
Schema Reference
required
Reference to the schema definition for the flow.
Additional properties
integer  | number  | string  | boolean 
optional
Example
{
    "flow_id": "af1853b0-cac5-4bee-8899-c0cd65319d06",
    "graph": {
        "nodes": [
            {
                "id": "laboris",
                "type": "dolor",
                "input": {},
                "config": {},
                "output": {},
                "store": {},
                "x-builder": {}
            }
        ],
        "edges": [
            {
                "name": "utrimque trans vulticulus",
                "source": "proident",
                "target": "nisi et amet proident",
                "condition": {}
            }
        ],
        "start_node": "sunt minim in dolore aute"
    },
    "schema": {
        "title": "vesica provident synagoga",
        "description": "Impedit arbitro adnuo decimus cumque. Saepe vesica laboriosam earum. Copia teneo undique libero texo decerno.",
        "type": "aute",
        "properties": {
            "id_9": -79612343.1564197,
            "Duis_b_": "minim exercitation eiusmod laboris"
        },
        "required": [
            "elit est aute non",
            "incididunt",
            "ex incididunt adipisicing consequat"
        ]
    },
    "stages": [
        {
            "name": "officiis crepusculum talio",
            "web": {
                "title": "debilito despecto videlicet",
                "description": "Amo corroboro bellum communis defero demoror capio ventito. Spargo caelestis aggredior autem consequuntur corroboro validus vicissitudo capitulus. Amitto terebro conforto vomito pauci.",
                "icon": "https://avatars.githubusercontent.com/u/13477490",
                "components": [
                    {
                        "type": "adipisicing nostrud veniam Ut ullamco",
                        "data": {
                            "query": "reprehenderit Duis Excepteur proident minim"
                        },
                        "crud_schema": {
                            "type": "dolore eiusmod",
                            "properties": {
                                "name": {
                                    "type": "veniam incididunt commodo",
                                    "title": "denuo tempore articulus"
                                },
                                "type": {
                                    "type": "veniam dolor laboris",
                                    "title": "non temporibus xiphias"
                                },
                                "status": {
                                    "type": "sed qui in ipsum",
                                    "title": "corrumpo cuppedia cohaero"
                                },
                                "url": {
                                    "type": "reprehenderit tempor",
                                    "title": "uter tersus victus"
                                }
                            }
                        }
                    },
                    {
                        "type": "magna tempor ut incididunt",
                        "data": {
                            "query": "dolore dolor velit eu occaecat"
                        },
                        "crud_schema": {
                            "type": "aliqua ut in minim elit",
                            "properties": {
                                "name": {
                                    "type": "elit",
                                    "title": "crepusculum collum adopto"
                                },
                                "type": {
                                    "type": "proident laborum",
                                    "title": "vindico voluptatum deduco"
                                },
                                "status": {
                                    "type": "sit culpa aute in laboris",
                                    "title": "eligendi conitor amita"
                                },
                                "url": {
                                    "type": "ex officia Ut ea veniam",
                                    "title": "veritas tamisium patrocinor"
                                }
                            }
                        }
                    },
                    {
                        "type": "sed",
                        "data": {
                            "query": "Excepteur esse aute minim irure"
                        },
                        "crud_schema": {
                            "type": "commodo sint nulla et",
                            "properties": {
                                "name": {
                                    "type": "dolor in ut et",
                                    "title": "audacia creator dolore"
                                },
                                "type": {
                                    "type": "enim aliqua ullamco",
                                    "title": "tutis quisquam possimus"
                                },
                                "status": {
                                    "type": "non cupidatat nulla magna ipsum",
                                    "title": "tego odio delinquo"
                                },
                                "url": {
                                    "type": "ut Lorem",
                                    "title": "vinitor angulus rem"
                                }
                            }
                        }
                    }
                ]
            }
        },
        {
            "name": "pectus sol cuppedia",
            "web": {
                "title": "quasi sono clam",
                "description": "Peccatus adversus consequuntur bis. Tempus repellat crur conservo balbus patruus amo synagoga necessitatibus. Coerceo vir anser depopulo damnatio utrum.",
                "icon": "https://avatars.githubusercontent.com/u/23456629",
                "components": [
                    {
                        "type": "occaecat sint Duis quis",
                        "data": {
                            "query": "sed adipisicing"
                        },
                        "crud_schema": {
                            "type": "sit Duis dolor",
                            "properties": {
                                "name": {
                                    "type": "aliquip dolore",
                                    "title": "solitudo tenax sol"
                                },
                                "type": {
                                    "type": "id cupidatat sunt dolore",
                                    "title": "sophismata ancilla magnam"
                                },
                                "status": {
                                    "type": "Excepteur",
                                    "title": "sulum crur venustas"
                                },
                                "url": {
                                    "type": "ad commodo consequat",
                                    "title": "cibo vindico admoneo"
                                }
                            }
                        }
                    },
                    {
                        "type": "et",
                        "data": {
                            "query": "voluptate exercitation in"
                        },
                        "crud_schema": {
                            "type": "velit voluptate eiusmod deserunt ex",
                            "properties": {
                                "name": {
                                    "type": "proident adipisicing do laborum dolor",
                                    "title": "admoveo quasi compello"
                                },
                                "type": {
                                    "type": "cupidatat eu",
                                    "title": "cado somnus claustrum"
                                },
                                "status": {
                                    "type": "in do fugiat",
                                    "title": "conatus catena crustulum"
                                },
                                "url": {
                                    "type": "minim",
                                    "title": "virgo patrocinor civitas"
                                }
                            }
                        }
                    }
                ]
            }
        }
    ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://preprod.api.crego.io/v1/rego/designs//' \
--header 'Content-Type: application/json' \
--data-raw '{
    "flow_id": "af1853b0-cac5-4bee-8899-c0cd65319d06",
    "graph": {
        "nodes": [
            {
                "id": "laboris",
                "type": "dolor",
                "input": {},
                "config": {},
                "output": {},
                "store": {},
                "x-builder": {}
            }
        ],
        "edges": [
            {
                "name": "utrimque trans vulticulus",
                "source": "proident",
                "target": "nisi et amet proident",
                "condition": {}
            }
        ],
        "start_node": "sunt minim in dolore aute"
    },
    "schema": {
        "title": "vesica provident synagoga",
        "description": "Impedit arbitro adnuo decimus cumque. Saepe vesica laboriosam earum. Copia teneo undique libero texo decerno.",
        "type": "aute",
        "properties": {
            "id_9": -79612343.1564197,
            "Duis_b_": "minim exercitation eiusmod laboris"
        },
        "required": [
            "elit est aute non",
            "incididunt",
            "ex incididunt adipisicing consequat"
        ]
    },
    "stages": [
        {
            "name": "officiis crepusculum talio",
            "web": {
                "title": "debilito despecto videlicet",
                "description": "Amo corroboro bellum communis defero demoror capio ventito. Spargo caelestis aggredior autem consequuntur corroboro validus vicissitudo capitulus. Amitto terebro conforto vomito pauci.",
                "icon": "https://avatars.githubusercontent.com/u/13477490",
                "components": [
                    {
                        "type": "adipisicing nostrud veniam Ut ullamco",
                        "data": {
                            "query": "reprehenderit Duis Excepteur proident minim"
                        },
                        "crud_schema": {
                            "type": "dolore eiusmod",
                            "properties": {
                                "name": {
                                    "type": "veniam incididunt commodo",
                                    "title": "denuo tempore articulus"
                                },
                                "type": {
                                    "type": "veniam dolor laboris",
                                    "title": "non temporibus xiphias"
                                },
                                "status": {
                                    "type": "sed qui in ipsum",
                                    "title": "corrumpo cuppedia cohaero"
                                },
                                "url": {
                                    "type": "reprehenderit tempor",
                                    "title": "uter tersus victus"
                                }
                            }
                        }
                    },
                    {
                        "type": "magna tempor ut incididunt",
                        "data": {
                            "query": "dolore dolor velit eu occaecat"
                        },
                        "crud_schema": {
                            "type": "aliqua ut in minim elit",
                            "properties": {
                                "name": {
                                    "type": "elit",
                                    "title": "crepusculum collum adopto"
                                },
                                "type": {
                                    "type": "proident laborum",
                                    "title": "vindico voluptatum deduco"
                                },
                                "status": {
                                    "type": "sit culpa aute in laboris",
                                    "title": "eligendi conitor amita"
                                },
                                "url": {
                                    "type": "ex officia Ut ea veniam",
                                    "title": "veritas tamisium patrocinor"
                                }
                            }
                        }
                    },
                    {
                        "type": "sed",
                        "data": {
                            "query": "Excepteur esse aute minim irure"
                        },
                        "crud_schema": {
                            "type": "commodo sint nulla et",
                            "properties": {
                                "name": {
                                    "type": "dolor in ut et",
                                    "title": "audacia creator dolore"
                                },
                                "type": {
                                    "type": "enim aliqua ullamco",
                                    "title": "tutis quisquam possimus"
                                },
                                "status": {
                                    "type": "non cupidatat nulla magna ipsum",
                                    "title": "tego odio delinquo"
                                },
                                "url": {
                                    "type": "ut Lorem",
                                    "title": "vinitor angulus rem"
                                }
                            }
                        }
                    }
                ]
            }
        },
        {
            "name": "pectus sol cuppedia",
            "web": {
                "title": "quasi sono clam",
                "description": "Peccatus adversus consequuntur bis. Tempus repellat crur conservo balbus patruus amo synagoga necessitatibus. Coerceo vir anser depopulo damnatio utrum.",
                "icon": "https://avatars.githubusercontent.com/u/23456629",
                "components": [
                    {
                        "type": "occaecat sint Duis quis",
                        "data": {
                            "query": "sed adipisicing"
                        },
                        "crud_schema": {
                            "type": "sit Duis dolor",
                            "properties": {
                                "name": {
                                    "type": "aliquip dolore",
                                    "title": "solitudo tenax sol"
                                },
                                "type": {
                                    "type": "id cupidatat sunt dolore",
                                    "title": "sophismata ancilla magnam"
                                },
                                "status": {
                                    "type": "Excepteur",
                                    "title": "sulum crur venustas"
                                },
                                "url": {
                                    "type": "ad commodo consequat",
                                    "title": "cibo vindico admoneo"
                                }
                            }
                        }
                    },
                    {
                        "type": "et",
                        "data": {
                            "query": "voluptate exercitation in"
                        },
                        "crud_schema": {
                            "type": "velit voluptate eiusmod deserunt ex",
                            "properties": {
                                "name": {
                                    "type": "proident adipisicing do laborum dolor",
                                    "title": "admoveo quasi compello"
                                },
                                "type": {
                                    "type": "cupidatat eu",
                                    "title": "cado somnus claustrum"
                                },
                                "status": {
                                    "type": "in do fugiat",
                                    "title": "conatus catena crustulum"
                                },
                                "url": {
                                    "type": "minim",
                                    "title": "virgo patrocinor civitas"
                                }
                            }
                        }
                    }
                ]
            }
        }
    ]
}'

Responses

🟢200Success
application/json
Body
id
string <uuid>
Design ID
read-onlyrequired
Globally unique identifier for the design.
Example:
123e4567-e89b-12d3-a456-426614174000
flow_id
string <uuid>
Flow ID
required
Globally unique identifier for the specific instance of the flow.
Example:
123e4567-e89b-12d3-a456-426614174001
secret_id
string <uuid>
required
is_current
boolean 
Is Current
required
Indicates if this design is the currently active one.
Examples:
truefalse
graph
object 
Flow Graph
required
Graph structure defining the nodes and edges of the flow.
nodes
array[object (Base Node) {5}] 
Nodes
required
List of nodes in the graph. Each node must be a non-empty string.
Examples:
node1node2node3
edges
$ref(#/definitions/4291925)[]
Edges
optional
Connections between nodes in the graph. Each edge must be a non-empty string.
Examples:
edge1edge2edge3
Could not resolve '#/definitions/4291925'
start_node
string 
Start Node
required
Default starting node in the graph.
Example:
node1
store_schema
object 
Schema Reference
required
Reference to the schema definition for the flow.
Additional properties
integer  | number  | string  | boolean 
optional
created_at
string <date-time>
Created At
read-onlyrequired
ISO 8601 timestamp when the design was created.
Example:
2024-11-27T00:00:00Z
updated_at
string <date-time> | null 
Updated At
read-onlyoptional
ISO 8601 timestamp when the design was last updated.
Example:
2024-11-27T01:00:00Z
updated_by
string  | null 
Updated By
optional
The identifier of the user who updated the edge. Must be 5-20 characters, allowing alphanumeric, dots, underscores, and dashes.
Match pattern:
"^[a-zA-Z0-9._-]{3,50}$"
created_by
string 
Created By
required
The identifier of the user who created the edge. Must be 5-20 characters, allowing alphanumeric, dots, underscores, and dashes.
Match pattern:
^[a-zA-Z0-9._-]{3,50}$
Example
{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "flow_id": "123e4567-e89b-12d3-a456-426614174001",
    "secret_id": "9e739c43-5a0b-4293-91b3-7c10894ec3f4",
    "is_current": true,
    "graph": {
        "nodes": "node1",
        "edges": "edge1",
        "start_node": "node1"
    },
    "store_schema": {},
    "created_at": "2024-11-27T00:00:00Z",
    "updated_at": "2024-11-27T01:00:00Z",
    "updated_by": "string",
    "created_by": "string"
}
Previous
List Designs
Next
Get Design
Built with