Persistence

{
  "extension": ".pdf",
  "presign_url_ttl": 30
}

{
  "extension": ".jpg",
  "blob_name": "image.jpg"
}

Blob has been created

{
  "blob_id": "8c561841-6671-412e-a356-523460ba0d8d",
  "extension": ".pdf",
  "presigned_urls": {
    "upload": {
      "url": "https://api-data-manager-blobs-bucket.s3.amazonaws.com/8c561841-6671-412e-a356-523460ba0d8d"
    }
  }
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

{
  "presign_url_ttl": 3600
}

New presigned url

{
  "url": "https://api-data-manager-blobs-bucket.s3.amazonaws.com/8c561841-6671-412e-a356-523460ba0d8d"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

Blob instance with last created presigned urls

{
  "blob_id": "8c561841-6671-412e-a356-523460ba0d8d",
  "extension": ".pdf",
  "presigned_urls": {
    "download": {
      "url": "https://api-data-manager-blobs-bucket.s3.amazonaws.com/8c561841-6671-412e-a356-523460ba0d8d"
    },
    "upload": {
      "url": "https://api-data-manager-blobs-bucket.s3.amazonaws.com/8c561841-6671-412e-a356-523460ba0d8d"
    }
  },
  "page_count": 3,
  "content_length": 7478
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

Presigned urls

{
  "download": {
    "url": "https://api-data-manager-blobs-bucket.s3.amazonaws.com/8c561841-6671-412e-a356-523460ba0d8d"
  },
  "upload": {
    "url": "https://api-data-manager-blobs-bucket.s3.amazonaws.com/8c561841-6671-412e-a356-523460ba0d8d"
  }
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

Presigned url

{
  "url": "https://api-data-manager-blobs-bucket.s3.amazonaws.com/8c561841-6671-412e-a356-523460ba0d8d"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

{
  "transaction_id": "01GSWRGPWD2C5SYPAN8TS4ZADJ",
  "collection_ids": [
    "01GSWRQXKK7AHPH4XG4DRHYXSZ",
    "01GSWS0PY75NFRHBFA4ERTFMD8"
  ]
}

{
  "transaction_id": "01GSWRGPWD2C5SYPAN8TS4ZADJ"
}

Ok.

{
  "merge_result": {
    "contact_information": [
      {
        "@id": "01FDF09BNQCT03DCAX7M5KM52T",
        "@type": "contact_information",
        "has_phone_number": {
          "has_value": "+1234567890"
        }
      }
    ],
    "employment": [
      {
        "@id": "01FDF0DFYAHBRJGFA5RS26HVP1",
        "@type": "employment",
        "has_employment_position_description": {
          "has_value": "Engineer"
        }
      }
    ],
    "people": [
      {
        "@id": "01FDF04MYHEZ98AD7T8ZGY5CMB",
        "@type": "borrower",
        "contact_at": [
          "01FDF09BNQCT03DCAX7M5KM52T"
        ],
        "employed_as": [
          "01FDF0DFYAHBRJGFA5RS26HVP1"
        ],
        "has_birth_date": {
          "has_value": "01/01/1985"
        },
        "has_first_name": {
          "has_value": "John"
        },
        "has_last_name": {
          "has_value": "Deere"
        },
        "has_taxpayer_identifier_value": {
          "has_value": "999-00-0000"
        },
        "lives_at": [
          "01GS59J4PHKYRH3D9TPAV3FK40",
          "01FD9XEX13TNAVJ0NJ23MYZM10"
        ]
      }
    ]
  }
}

Request data invalid

{
  "message": "Request body is not valid JSON."
}

{
  "query": {
    "path": {
      "path": "$.people[0].has_first_name.has_value",
      "format": "jsonpath"
    },
    "operation": "eq",
    "value": "Vlad"
  }
}

{
  "query": {
    "path": {
      "path": "$.people[0].has_first_name.has_value",
      "format": "jsonpath"
    },
    "operation": "eq",
    "value": "Vlad"
  },
  "latest_collections_only": true
}

{
  "query": {
    "path": {
      "path": "$.people[0].has_first_name.has_value",
      "format": "jsonpath"
    },
    "operation": "eq",
    "value": "Vlad"
  },
  "page": 1,
  "next_token": "7b22637265617465645f6174223a2022323032332d30322d32325431383a31333a32352e3834373236372b30323a3030222c20226f6666736574223a20313030307d"
}

{
  "query": {
    "path": {
      "path": "$.people[0].has_first_name.has_value",
      "format": "jsonpath"
    },
    "operation": "eq",
    "value": "Vlad"
  },
  "transaction_label": "prod"
}

{
  "query": {
    "path": {
      "path": "people[0].has_first_name.has_value",
      "format": "jmespath"
    },
    "operation": "eq",
    "value": "Vlad"
  }
}

{
  "query": {
    "path": {
      "path": "$.people[*].has_credit_score.has_value",
      "format": "jsonpath"
    },
    "operation": "between",
    "value": [
      400,
      500
    ]
  }
}

{
  "query": {
    "path": {
      "path": "$.people[?(@.has_first_name.has_value = 'Vlad')].has_last_name.has_value",
      "format": "jsonpath"
    },
    "operation": "eq",
    "value": "K"
  }
}

{
  "query": {
    "path": {
      "path": "$.people[?(@.has_first_name.has_value = 'Vlad')].with_addresses[?(@.has_city_name.has_value = 'New York')].has_state_name.has_value",
      "format": "jsonpath"
    },
    "operation": "eq",
    "value": "NY"
  }
}

{
  "query": {
    "path": {
      "path": "$.people[*].with_addresses[*].has_state_name.has_value",
      "format": "jsonpath"
    },
    "operation": "startswith",
    "value": "N"
  }
}

{
  "query": {
    "path": {
      "path": "$.people[*].has_last_name.has_value",
      "format": "jsonpath"
    },
    "operation": "contains",
    "value": "mik"
  }
}

{
  "query": {
    "path": {
      "path": "$.people[*].has_credit_score.has_value",
      "format": "jsonpath"
    },
    "operation": "ne",
    "value": 200
  }
}

{
  "query": {
    "path": {
      "path": "$.people[*].has_credit_score.has_value",
      "format": "jsonpath"
    },
    "operation": "gt",
    "value": 200
  }
}

{
  "query": {
    "path": {
      "path": "$.people[*].has_credit_score.has_value",
      "format": "jsonpath"
    },
    "operation": "gte",
    "value": 200
  }
}

{
  "query": {
    "path": {
      "path": "$.people[*].has_credit_score.has_value",
      "format": "jsonpath"
    },
    "operation": "lt",
    "value": 200
  }
}

{
  "query": {
    "path": {
      "path": "$.people[*].has_credit_score.has_value",
      "format": "jsonpath"
    },
    "operation": "lte",
    "value": 200
  }
}

{
  "query": {
    "and": [
      {
        "path": {
          "path": "$.people[*].has_credit_score.has_value",
          "format": "jsonpath"
        },
        "operation": "eq",
        "value": 200
      },
      {
        "and": [
          {
            "path": {
              "path": "$.people[*].has_first_name.has_value",
              "format": "jsonpath"
            },
            "operation": "eq",
            "value": "Bob"
          },
          {
            "path": {
              "path": "$.people[*].has_last_name.has_value",
              "format": "jsonpath"
            },
            "operation": "eq",
            "value": "Odenkirk"
          }
        ]
      }
    ]
  }
}

{
  "query": {
    "or": [
      {
        "path": {
          "path": "$.people[*].has_credit_score.has_value",
          "format": "jsonpath"
        },
        "operation": "eq",
        "value": 200
      },
      {
        "and": [
          {
            "path": {
              "path": "$.people[*].has_first_name.has_value",
              "format": "jsonpath"
            },
            "operation": "eq",
            "value": "Bob"
          },
          {
            "path": {
              "path": "$.people[*].has_last_name.has_value",
              "format": "jsonpath"
            },
            "operation": "eq",
            "value": "Odenkirk"
          }
        ]
      }
    ]
  }
}

{
  "query": {
    "and": [
      {
        "or": [
          {
            "path": {
              "path": "people[*].has_credit_score.has_value",
              "format": "jmespath"
            },
            "operation": "eq",
            "value": 200
          },
          {
            "path": {
              "path": "$.people[*].has_last_name.has_value",
              "format": "jsonpath"
            },
            "operation": "eq",
            "value": "K"
          }
        ]
      },
      {
        "and": [
          {
            "path": {
              "path": "$.people[*].has_first_name.has_value",
              "format": "jsonpath"
            },
            "operation": "eq",
            "value": "Bob"
          },
          {
            "path": {
              "path": "$.people[*].has_last_name.has_value",
              "format": "jsonpath"
            },
            "operation": "eq",
            "value": "Odenkirk"
          }
        ]
      }
    ]
  }
}

{
  "query": {
    "path": {
      "path": "$.people[0].has_first_name.has_value",
      "format": "jsonpath"
    },
    "operation": "eq",
    "value": "Vlad"
  },
  "next_token": "7b22637265617465645f6174223a2022323032332d30322d32325431383a31333a32352e3834373236372b30323a3030222c20226f6666736574223a20313030307d"
}

{
  "query": {
    "path": {
      "path": "$.people[0].has_first_name.has_value",
      "format": "jsonpath"
    },
    "operation": "eq",
    "value": "Vlad"
  },
  "limit": 150
}

{
  "query": {
    "path": {
      "path": "$.people[0].has_first_name.has_value",
      "format": "jsonpath"
    },
    "operation": "eq",
    "value": "Vlad"
  },
  "include_total_count": true
}

Ok.

{
  "query_result": [
    {
      "transaction_id": "01GSD62EEBT4YD1Y0W6GFVA4EB",
      "collection_id": "01GSD68Z48JRJK8MM4YYRCTH3D"
    },
    {
      "transaction_id": "01GSD62EEBT4YD1Y0W6GFVA4EB",
      "collection_id": "01GSD6AC2XH7QW4N8RE67QB0Z9"
    }
  ],
  "next_token": "7b22637265617465645f6174223a2022323032332d30322d32325431383a31333a32352e3834373236372b30323a3030222c20226f6666736574223a20313030307d",
  "total_count": 42
}

Request data invalid

{
  "message": "Invalid path. Reason: Invalid JSONPATH."
}

Request data failed validation

{
  "detailedMessage": "Malformed query",
  "code": "MalformedQueryException"
}

OK response

{
  "ok": true
}

{
  "name": "borrower_ssn",
  "path": {
    "path": "$.people[?(@['@type'] == 'borrower')].has_taxpayer_identifier_value.has_value",
    "format": "jsonpath"
  }
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

Index

{
  "message": "Index deleted"
}

Requested resource not found

{
  "message": "Collection not found"
}

Index

{
  "name": "borrower_ssn",
  "path": {
    "path": "$.people[@['@type'] == 'borrower'].has_taxpayer_identifier_value.has_value",
    "format": "jsonpath"
  }
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

{
  "transaction_ids": [
    "01EZQ32NEN5VDHE288WN4TV2D3",
    "01EZQ32NEN5VDHE288WN4TV2D4"
  ]
}

{
  "transaction_label": "my_transaction_label"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

Conflict

{
  "message": "Index name 'x' already exists"
}

{
  "or": [
    {
      "and": [
        {
          "index_name": "foo",
          "operation": "eq",
          "value": 23
        },
        {
          "index_name": "bar",
          "operation": "startswith",
          "value": "grate"
        }
      ]
    },
    {
      "index_name": "baz",
      "operation": "between",
      "value": [
        20,
        35
      ]
    }
  ]
}

{
  "index_name": "foo",
  "operation": "eq",
  "value": 23
}

{
  "classes": [
    {
      "type": "person",
      "container_name": "people",
      "is_deprecated": false,
      "deprecated_properties": [],
      "properties": {
        "first_name": {
          "type": "boolean"
        }
      }
    },
    {
      "type": "address",
      "container_name": "addresses",
      "is_deprecated": false,
      "deprecated_properties": [
        "address_line_deprecated"
      ],
      "properties": {
        "address_type": {
          "type": "string",
          "enum": [
            "Mailing",
            "Current"
          ]
        },
        "address_line_1": {
          "type": "string"
        },
        "address_line_deprecated": {
          "type": "string"
        }
      }
    },
    {
      "type": "credit",
      "container_name": "credits",
      "is_deprecated": false,
      "deprecated_properties": [],
      "properties": {
        "credit_identifier": {
          "type": "string"
        }
      },
      "relationships": {
        "owed_to": {
          "targets": [
            "person"
          ]
        }
      }
    },
    {
      "type": "finance_relation",
      "container_name": "relationships",
      "relationships": {
        "has_person": {
          "targets": [
            "person"
          ]
        }
      }
    },
    {
      "type": "contact_relation",
      "container_name": "relationships",
      "relationships": {
        "my_id": {
          "targets": [
            "person"
          ]
        }
      }
    }
  ]
}

Request data failed validation

{
  "detailedMessage": "Bad request exception"
}

Requested resource not found

{
  "message": "Configuration not found"
}

List of configurations

{
  "configurations": [
    {
      "slack_webhook_url": "https://hooks.slack.com/services/ABCZXC/B00000000/ABCZXCJWKM"
    }
  ]
}

Requested resource not found

{
  "message": "Configuration not found"
}

{
  "slack_webhook_url": "https://hooks.slack.com/services/ABCZXC/B00000000/ABCZXCJWKM"
}

Configuration created

{
  "slack_webhook_url": "https://hooks.slack.com/services/ABCZXC/B00000000/ABCZXCJWKM"
}

Request data failed validation

{
  "detailedMessage": "Bad request exception"
}

{
  "transaction_id": "01G92FSH5FYKQE6X22FECB95V2",
  "collection_id": "01G92FSX8A9YXPAMT6V97TH0VZ"
}

Accepted.

{
  "collection_id": "01G92FWG135BTEMQC3SSMA8Q7A"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

OK.

{
  "invocations": [
    {
      "invocation_id": "01G92FWG135BTEMQC3SSMA8Q7A"
    },
    {
      "invocation_id": "01G92FWG135BTEMQC3SSMA8Q7B"
    },
    {
      "invocation_id": "01G92FWG135BTEMQC3SSMA8Q7C"
    }
  ]
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

OK.

{
  "invocations": [
    {
      "invocation_id": "01G92FWG135BTEMQC3SSMA8Q7A"
    },
    {
      "invocation_id": "01G92FWG135BTEMQC3SSMA8Q7B"
    },
    {
      "invocation_id": "01G92FWG135BTEMQC3SSMA8Q7C"
    }
  ]
}

Requested resource not found

{
  "message": "Collection not found"
}

queried

[
  {
    "Options": {
      "IndexFieldName": "name",
      "IndexFieldType": "text-array"
    },
    "Status": {
      "CreationDate": "2023-04-03T01:02:06.541Z",
      "UpdateDate": "2023-04-03T01:02:06.541Z",
      "UpdateVersion": 1,
      "State": "Active",
      "PendingDeletion": false
    }
  }
]

Request data failed validation

{
  "detailedMessage": "Malformed query",
  "code": "MalformedQueryException"
}

Requested resource not found

{
  "message": "Collection not found"
}

{
  "index_name": "addresses/has_state_code/has_value"
}

queried

{
  "IndexField": {
    "Status": {
      "CreationDate": "2023-04-03T01:02:06.541Z",
      "UpdateDate": "2023-04-03T01:02:06.541Z",
      "State": "Active"
    }
  }
}

Request data failed validation

{
  "detailedMessage": "Malformed query",
  "code": "MalformedQueryException"
}

Conflict

{
  "message": "Index name 'x' already exists"
}

{
  "fields": [
    {
      "field": "addresses/has_state_name/has_value",
      "value": "CA",
      "distance": 10,
      "weight": 0.5
    }
  ]
}

{
  "fields": [
    {
      "field": "addresses/has_state_name/has_value",
      "value": "CA",
      "distance": 10,
      "weight": 0.5
    }
  ],
  "latest_transaction_collection": true
}

{
  "fields": [
    {
      "field": "addresses/has_state_name/has_value",
      "value": "CA",
      "distance": 10,
      "weight": 0.5
    }
  ],
  "transaction_label": "01GZNQYD9H0J2Z57F4JJJTKQ1Q"
}

Queried response

[
  {
    "transaction_id": "01GV5S3SYTEX8QSVEWSPVQHNQS",
    "score": 0.95,
    "collection_id": "01GV5S40XNZ47YYASFRE78GXW1"
  }
]

Request data failed validation

{
  "detailedMessage": "Malformed query",
  "code": "MalformedQueryException"
}

{
  "item": {
    "@type": "Address",
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip": 12345
  }
}

Created item successfully

{
  "item": {
    "@id": "1234567890",
    "@type": "Address",
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip": 12345
  }
}

Request data failed validation

{
  "detailedMessage": "Bad request exception"
}

Requested resource not found

{
  "message": "Container not found"
}

Conflict

{
  "message": "Item with @id 'x' already exists"
}

Get item successfully

{
  "item": {
    "@id": "1234567890",
    "@type": "Address",
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip": 12345
  },
  "container_name": "addresses"
}

Request data failed validation

{
  "detailedMessage": "Bad request exception"
}

Requested resource not found

{
  "message": "Container not found"
}

{
  "items": [
    {
      "@type": "person",
      "@id": "01GYSJNDZMZB37TNTWY8KVVSSC",
      "first_name": "John",
      "last_name": "Doe"
    },
    {
      "@type": "address",
      "@id": "01GYSVT1BCQHEFDY86FKGGX8PD",
      "city": "LA"
    },
    {
      "@type": "person_address_relation",
      "@id": "01GYSW9BAD87KKQM7F0GYK1AG3",
      "has_address": "01GYSVT1BCQHEFDY86FKGGX8PD",
      "has_person": "01GYSJNDZMZB37TNTWY8KVVSSC"
    }
  ]
}

Created item successfully

{
  "upload_id": "1234567890"
}

Request data failed validation

{
  "detailedMessage": "Bad request exception"
}

Requested resource not found

{
  "message": "Container not found"
}

Conflict

{
  "message": "Item with @id 'x' already exists"
}

Created item successfully

{
  "upload_id": "1234567890",
  "status": "COMPLETED"
}

Request data failed validation

{
  "detailedMessage": "Bad request exception"
}

Requested resource not found

{
  "message": "Container not found"
}

Conflict

{
  "message": "Item with @id 'x' already exists"
}

{
  "type": "person",
  "properties": [
    "first_name",
    "last_name"
  ]
}

{
  "type": "person",
  "properties": [
    "first_name",
    "last_name"
  ],
  "conditions": {
    "first_name": {
      "condition": "eq",
      "value": "John"
    }
  }
}

{
  "type": "person",
  "properties": [
    "first_name",
    "last_name"
  ],
  "relations": [
    {
      "relationship": "earns",
      "type": "income",
      "properties": [
        "annual_income"
      ],
      "conditions": {
        "annual_income": {
          "condition": "gt",
          "value": 50000
        }
      },
      "required": true
    }
  ]
}

{
  "type": "person",
  "properties": [
    "age"
  ],
  "group_by": "age"
}

{
  "type": "person",
  "properties": [
    "*"
  ]
}

{
  "type": "person",
  "properties": [
    "last_name",
    "first_name"
  ],
  "aggregate": {
    "function": "max",
    "attribute": "last_name"
  },
  "group_by": "first_name"
}

{
  "type": "person",
  "properties": [
    "first_name",
    "last_name",
    "email"
  ],
  "optional_properties": [
    "email"
  ]
}

{
  "type": "person",
  "properties": [
    "first_name",
    "last_name",
    "email"
  ],
  "optional_properties": [
    "email"
  ],
  "relations": [
    {
      "relationship": "earns",
      "type": "income",
      "properties": [
        "annual_income"
      ],
      "conditions": {
        "annual_income": {
          "condition": "gt",
          "value": 50000
        }
      },
      "required": true
    }
  ],
  "group_by": "first_name",
  "aggregate": {
    "function": "max",
    "attribute": "last_name"
  },
  "pagination": {
    "limit": 10
  },
  "echo": true
}

Succeeded

{
  "items": [
    {
      "@id": "01H7AAJJP33QV8V7EAG26MYZP1",
      "@type": "person",
      "first_name": "Leo",
      "last_name": "Messi",
      "person_identifier": "5ba3cf68-0eba-4011-a70b-a47899c2f986",
      "email": "messi@domain.com",
      "earns": {
        "@id": "01H7AAMTBJHDS4CB38PVZ62VCW",
        "@type": "income",
        "annual_income": 50001,
        "bonus_income_amount": 200,
        "income_identifier": "3b317e55-3614-4e97-b2df-e117b8834197"
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "next_token": "39373833613763612d363461662d346231342d383035372d393535346138323363646337"
  }
}

Request data failed validation

{
  "detailedMessage": "Bad request exception"
}

Requested resource not found

{
  "message": "Container not found"
}

Conflict

{
  "message": "Item with @id 'x' already exists"
}

Succeeded

{
  "item": {
    "@id": "1234567890",
    "@type": "Address",
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip": 12345
  },
  "version": 1
}

Request data failed validation

{
  "detailedMessage": "Bad request exception"
}

Requested resource not found

{
  "message": "Container not found"
}

{
  "item": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip": 12345
  }
}

Created item successfully

{
  "status": "success",
  "message": "Item updated successfully and previous version created.",
  "updated_item": {
    "@id": "AJXZ159292",
    "@type": "Address",
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip": 12345
  },
  "versioned_item": {
    "@id": "AJXZ159292_v1",
    "@type": "Address",
    "street": "456 Old St",
    "city": "Oldtown",
    "state": "CA",
    "zip": 67890,
    "sc:version": 1
  }
}

Request data failed validation

{
  "detailedMessage": "Bad request exception"
}

Requested resource not found

{
  "message": "Container not found"
}

{
  "label": "first_transaction"
}

Transaction have been created

{
  "transaction_id": "01EZQ32PJQGKRA6HR8D72Q9FFF",
  "created_at": "2024-03-29T05:32:11.731227-04:00"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Transaction

{
  "transaction_id": "01EZQ32PJQGKRA6HR8D72Q9FFF",
  "created_at": "2024-03-29T05:32:11.731227-04:00"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Requested resource not found

{
  "message": "Collection not found"
}