openapi.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "EVRYTHNG REST API",
    "description": "The EVRYTHNG RESTful API for developers on the EVRYTHNG Platform.",
    "termsOfService": "https://developers.evrythng.com/docs/usage-guidelines",
    "contact": {
      "name": "EVRYTHNG Support",
      "url": "https://developers.evrythng.com/docs/support",
      "email": "service-desk@evrythng.com"
    },
    "license": {
      "name": "EVRYTHNG Service Level Agreement",
      "url": "https://evrythng.com/legal/sla/"
    },
    "version": "1.0.0"
  },
  "paths": {
    "/access": {
      "get": {
        "tags": [
          "Access"
        ],
        "summary": "Read key access information",
        "description": "Read key access information for the authenticating key.",
        "responses": {
          "200": {
            "description": "The access information for the authenticating key.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/KeyAccessDocument"
                },
                "example": {
                  "account": "UFNCRXfCVM87QNawaE8rrKqc",
                  "actor": {
                    "type": "operator",
                    "id": "U2NCaXfCBgPaQ5wRwhTsWnmc"
                  }
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application",
          "Trusted Application",
          "Application User",
          "Device"
        ]
      }
    },
    "/accessPolicies/{accessPolicyId}": {
      "get": {
        "summary": "Read an access policy",
        "description": "Read an access policy resource.",
        "tags": [
          "Access Policies"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accessPolicyId"
          }
        ],
        "responses": {
          "200": {
            "description": "The access policy was found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessPolicyDocument"
                },
                "example": {
                  "name": "FactoryAdministratorPolicy",
                  "permissions": [
                    "actions:create",
                    "places:list,read,update",
                    "products:list,read",
                    "purchaseOrders:list,read",
                    "thngs:read"
                  ],
                  "uiPermissions": [
                    "activation",
                    "authenticate"
                  ]
                }
              }
            }
          },
          "404": {
            "description": "The access policy was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The requested resource was not found."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      },
      "put": {
        "summary": "Update an access policy",
        "description": "Update an access policy resource.",
        "tags": [
          "Access Policies"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accessPolicyId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccessPolicyDocument"
              },
              "example": {
                "name": "FactoryAdministratorPolicy",
                "permissions": [
                  "actions:create",
                  "places:list,read,update",
                  "products:list,read",
                  "purchaseOrders:list,read",
                  "thngs:read"
                ],
                "uiPermissions": [
                  "activation",
                  "authenticate"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The Access policy was updated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessPolicyDocument"
                },
                "example": {
                  "name": "FactoryAdministratorPolicy",
                  "permissions": [
                    "actions:create",
                    "places:list,read,update",
                    "products:list,read",
                    "purchaseOrders:list,read",
                    "thngs:read"
                  ],
                  "uiPermissions": [
                    "activation",
                    "authenticate"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Access policy update payload did not validate.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "Access policy ID in request body does not match ID in URL."
                  ],
                  "code": 50593792,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50593792"
                }
              }
            }
          },
          "404": {
            "description": "The Access policy was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The requested resource was not found."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Delete an access policy",
        "description": "Delete an access policy.",
        "tags": [
          "Access Policies"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accessPolicyId"
          }
        ],
        "responses": {
          "204": {
            "description": "The Access policy was deleted."
          },
          "403": {
            "description": "The Access policy is a managed policy.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 403,
                  "errors": [
                    "A managed policy cannot be deleted."
                  ],
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-and-error-codes#section-error-codes"
                }
              }
            }
          },
          "404": {
            "description": "The Access policy was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The access policy does not exist."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      }
    },
    "/accessPolicies": {
      "post": {
        "summary": "Create an access policy",
        "description": "Create a new access policy resource.",
        "tags": [
          "Access Policies"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccessPolicyDocument"
              },
              "example": {
                "name": "FactoryAdministratorPolicy",
                "permissions": [
                  "actions:create",
                  "places:list,read,update",
                  "products:list,read",
                  "purchaseOrders:list,read",
                  "thngs:read"
                ],
                "uiPermissions": [
                  "activation",
                  "authenticate"
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The access policy was successfully created.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessPolicyDocument"
                },
                "example": {
                  "name": "FactoryAdministratorPolicy",
                  "permissions": [
                    "actions:create",
                    "places:list,read,update",
                    "products:list,read",
                    "purchaseOrders:list,read",
                    "thngs:read"
                  ],
                  "uiPermissions": [
                    "activation",
                    "authenticate"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "An access policy was not created because the request was invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "AccessPolicy should have required property 'name'"
                  ],
                  "code": 50331648,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50331648"
                }
              }
            }
          },
          "409": {
            "description": "An access policy was not created because one with the same name already exists within this account.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 409,
                  "errors": [
                    "The access policy already exists"
                  ],
                  "code": 67239936,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-67239936"
                }
              }
            }
          }
        }
      },
      "get": {
        "summary": "Read all access policies",
        "description": "Read all access policies in an account",
        "tags": [
          "Access Policies"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "responses": {
          "200": {
            "description": "A list of access policies",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AccessPolicyDocument"
                  }
                },
                "example": [
                  {
                    "name": "FactoryAdministratorPolicy",
                    "description": "Description of FactoryAdministratorPolicy",
                    "permissions": [
                      "actions:create",
                      "places:list,read,update",
                      "products:list,read",
                      "purchaseOrders:list,read",
                      "thngs:read"
                    ],
                    "uiPermissions": [
                      "activation",
                      "authenticate"
                    ],
                    "homepage": "authenticate",
                    "identifiers": {
                      "ean": "aen232032"
                    },
                    "tags": [
                      "roles",
                      "and",
                      "permissions"
                    ]
                  },
                  {
                    "name": "BrandOwnerPolicy",
                    "permissions": [
                      "actions:create",
                      "places:list,read,update",
                      "products:list,read",
                      "purchaseOrders:list,read",
                      "thngs:read"
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    },
    "/accessTokens": {
      "get": {
        "summary": "Read service access tokens",
        "description": "Read all service accesses for an account",
        "tags": [
          "Enterprise Access"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AccessTokenDocument"
                  }
                },
                "example": [
                  {
                    "name": "operator@email.com",
                    "description": "Factory worker",
                    "policies": [
                      1.2345678901234569e+23
                    ],
                    "conditions": [
                      "places:123932QJ1235823412S741WG4"
                    ]
                  }
                ]
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "Invalid key"
                  ],
                  "code": 50724864,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50724864"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create an access token",
        "description": "Creates an access token for given account.",
        "tags": [
          "Enterprise Access"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccessTokenDocument"
              },
              "example": {
                "name": "operator@email.com",
                "description": "access description",
                "policies": [
                  1.2345678901234569e+23
                ],
                "conditions": [
                  "places:UPfPCQTASm6B8yx4eDMWDQcg"
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessTokenDocument"
                },
                "example": {
                  "name": "operator@email.com",
                  "description": "access description",
                  "policies": [
                    1.2345678901234569e+23
                  ],
                  "conditions": [
                    "places:UPfAtMqWAm3GwqSdg7Htsngb"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "Invalid key"
                  ],
                  "code": 50724864,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50724864"
                }
              }
            }
          }
        }
      }
    },
    "/accesses/{accessId}": {
      "delete": {
        "tags": [
          "Access"
        ],
        "summary": "Delete an access",
        "description": "Delete an existing Application User access to revoke it. Either the granting or receiving user can do this.",
        "parameters": [
          {
            "$ref": "#/components/parameters/accessId"
          }
        ],
        "responses": {
          "204": {
            "description": "The access was deleted successfully."
          }
        },
        "x-api-keys": [
          "Application User"
        ]
      }
    },
    "/accesses": {
      "post": {
        "tags": [
          "Access"
        ],
        "summary": "Create a new access",
        "description": "Create a new access for another Application User.",
        "responses": {
          "201": {
            "description": "The access was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserAccessDocument"
                },
                "example": {
                  "id": "59ad60d9b24413002c7d7695",
                  "project": "UG4WExTKBqPr9NwRa3twYDnk",
                  "app": "UG4NWfQ7BMPN97wawGQRrxtm",
                  "user": "UGHrfg5XB6PNQraaamtRNbts",
                  "actor": "UGH7CG5WeqP7tNRawGQwrydc",
                  "role": "59a676cc6404572c00294433",
                  "customFields": {
                    "email": "test@example.com"
                  }
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationUserAccessDocument"
              },
              "example": {
                "email": "test@example.com",
                "role": "59a676cc6404572c00294433"
              }
            }
          },
          "description": "The details required to create an Application User access.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Access"
        ],
        "summary": "Read all accesses",
        "description": "Read an Application User's available acesses.",
        "responses": {
          "200": {
            "description": "The list of available accesses.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApplicationUserAccessDocument"
                  }
                },
                "example": [
                  {
                    "id": "5d5d3d37a47f8500331b2c6b",
                    "project": "UNBEtGtxyw4ABpRRwmpfcrCg",
                    "app": "UNeht3QSKtVgPnaaRtBbcNpc",
                    "user": "UNCNd7AYrkD6sEwwwGbeUcyr",
                    "actor": "UNCNd7AYrkD6sEwwwGbeUcyr",
                    "apiKey": "Bj9XmUdjFcYVszKLX1..."
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Application User"
        ]
      }
    },
    "/accounts/{accountId}/accesses/{accessId}": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Read an account access",
        "description": "Read an account access by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          },
          {
            "$ref": "#/components/parameters/accessId"
          }
        ],
        "responses": {
          "200": {
            "description": "The access requested, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessDocument"
                },
                "example": {
                  "id": "57bad69fc18104025b292da8",
                  "account": "UhpHrg39QCy9dsSddN8xhwnb",
                  "operator": "UEp4rDGsnpCAF6xABbys5Amc",
                  "apiKey": "RHADMAdGAw3txdFemb7xYXtkClrtiHvibJRKCFa8...",
                  "role": "5889cd38c4b3762e00667633"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "Accounts"
        ],
        "summary": "Update an account access",
        "description": "Update an account access to set a new role.",
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          },
          {
            "$ref": "#/components/parameters/accessId"
          }
        ],
        "responses": {
          "200": {
            "description": "The access was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessDocument"
                },
                "example": {
                  "id": "57bad69fc18104025b292da8",
                  "account": "UhpHrg39QCy9dsSddN8xhwnb",
                  "operator": "UEp4rDGsnpCAF6xABbys5Amc",
                  "apiKey": "RHADMAdGAw3txdFemb7xYXtkClrtiHvibJRKCFa8...",
                  "role": "5889cd38c4b3762e00667633"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccessDocument"
              },
              "example": {
                "role": "admin"
              }
            }
          },
          "description": "The AccessDocument containing the role to create/update.",
          "required": true
        }
      }
    },
    "/accounts/{accountId}/accesses": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Read account accesses",
        "description": "Read an account's access information and current role.",
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of the account's accesses.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AccessDocument"
                  }
                },
                "example": [
                  {
                    "id": "5aa7f5e7f6c02e003006ace0",
                    "account": "UHHEQWPYeg8RtpaawkFrksDp",
                    "operator": "UH4YtfsYBD8wQpwwRktfsrRg",
                    "apiKey": "lw7dzUvfLGmdTzvv...",
                    "role": "admin"
                  },
                  {
                    "id": "5aa7f64b6ca8b70030800024",
                    "account": "UHHEQWPYeg8RtpaawkFrksDp",
                    "operator": "UEp4rDGsnpCAF6xABbys5Amc",
                    "apiKey": "VBBFEv9os46i0xqm...",
                    "role": "admin"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/accounts/{accountId}/domains": {
      "get": {
        "tags": [
          "Domains"
        ],
        "summary": "Read account domains",
        "description": "Read all domains available to an account.",
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of the account's domains.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/DomainDocument"
                  }
                },
                "example": [
                  {
                    "createdAt": 1519385011833,
                    "updatedAt": 1519385011833,
                    "id": "5a8ff9b3a1b3f60013492de7",
                    "accountId": "UnFQtmpUMtQBY8wRaEystb5h",
                    "domain": "6rt0s.v.tn.gg"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/accounts/{accountId}/operatorAccess/{operatorAccessId}": {
      "get": {
        "summary": "Get an account Operator access",
        "description": "Reads and returns account operator access by ID",
        "tags": [
          "Enterprise Access"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          },
          {
            "$ref": "#/components/parameters/operatorAccessId"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OperatorAccessDocument"
                },
                "example": {
                  "id": "Ud6TycDekE5afp6M8QAEEMhp",
                  "operator": "123932QJ1235823412S741WG4",
                  "name": "first last",
                  "email": "operator@email.com",
                  "description": "access description",
                  "policies": [
                    1.2345678901234569e+23
                  ],
                  "conditions": [
                    "places:UPBCycCpgVGArgYc5y5UnkAg"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "The actor account can not manage the account provided in URL."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          },
          "404": {
            "description": "Not found\ncontent:\n  application/json:\n    schema:\n      $ref: '#/components/schemas/ErrorResponseDocument'\n    example:\n      status: 404\n      errors:\n        - account is invalid.\n        - The requested operator access was not found.\n        - The provided operator access account was not found.\n      code: 16842752\n      moreInfo: https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
          }
        }
      },
      "put": {
        "summary": "Update operator access by ID",
        "description": "Updates and returns operator access by ID",
        "tags": [
          "Enterprise Access"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          },
          {
            "$ref": "#/components/parameters/operatorAccessId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OperatorAccessDocument"
              },
              "example": {
                "name": "operator@email.com",
                "description": "Factory admin",
                "policies": [
                  "123456789012345678901234"
                ],
                "conditions": [
                  "places:123932QJ1235823412S741WG4'"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OperatorAccessDocument"
                },
                "example": {
                  "id": "Ud6TycDekE5afp6M8QAEEMhp",
                  "name": "first last",
                  "email": "operator@email.com",
                  "operator": 1.2345678901234569e+23,
                  "description": "Factory admin",
                  "policies": [
                    1.2345678901234569e+23
                  ],
                  "conditions": [
                    "places:UPBCycCpgVGArgYc5y5UnkAg"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "invalid payload",
                    "The actor account can not manage the account provided in URL.",
                    "The provided operator was not found.",
                    "Invalid policies provided.",
                    "Unsupported conditions.",
                    "Caller access exceeded."
                  ],
                  "code": 50593792,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50593792"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The requested resource was not found.",
                    "The account specified was invalid."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Delete an Operator Access",
        "description": "Deletes an account operator access by ID",
        "tags": [
          "Enterprise Access"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          },
          {
            "$ref": "#/components/parameters/operatorAccessId"
          }
        ],
        "responses": {
          "204": {
            "description": "A confirmation of deletion of the operator access",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": [
                  "status 204"
                ]
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The provided operator access account was not found.",
                    "The provided operator access was not found."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          },
          "409": {
            "description": "It is not possible to remove the last admin on an account.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 409,
                  "errors": [
                    "At least one Administrator required for the account."
                  ],
                  "code": 67239936,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-67239936"
                }
              }
            }
          }
        }
      }
    },
    "/accounts/{accountId}/operatorAccess": {
      "get": {
        "summary": "Read all Operator Accesses",
        "description": "Read all operator access for given account",
        "tags": [
          "Enterprise Access"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/OperatorAccessDocument"
                  }
                },
                "example": [
                  {
                    "id": "Ud6TycDekE5afp6M8QAEEMhp",
                    "name": "first last",
                    "operator": "123456789012345678901234",
                    "email": "operator@email.com",
                    "description": "access description",
                    "policies": [
                      1.2345678901234569e+23
                    ],
                    "conditions": [
                      "places:UPfPCQTASm6B8yx4eDMWDQcg"
                    ]
                  }
                ]
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "The actor account can not manage the account provided in URL."
                  ],
                  "code": 50659328,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50659328"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The provided operator access account was not found."
                  ],
                  "code": 16777216,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16777216"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create an Operator Access",
        "description": "Creates an operator access for account",
        "tags": [
          "Enterprise Access"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OperatorAccessDocument"
              },
              "example": {
                "email": "operator@email.com",
                "description": "Access for a factory administrator",
                "policies": [
                  1.2345678901234569e+23
                ],
                "conditions": [
                  "places:UPBCycCpgVGArgYc5y5UnkAg"
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OperatorAccessDocument"
                },
                "example": {
                  "id": "Ud6TycDekE5afp6M8QAEEMhp",
                  "name": "first last",
                  "operator": 1.2345678901234569e+23,
                  "email": "operator@email.com",
                  "description": "access description",
                  "policies": [
                    1.2345678901234569e+23
                  ],
                  "conditions": [
                    "places:UPBCycCpgVGArgYc5y5UnkAg"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "Invalid payload",
                    "The actor account can not manage the account provided in URL",
                    "The provided operator was not found",
                    "Invalid policies provided",
                    "Unsupported conditions",
                    "Caller access exceeded",
                    "The provided operator was not found"
                  ],
                  "code": 50593792,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50593792"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The requested resource was not found.",
                    "account is invalid."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      }
    },
    "/accounts/{accountId}/shortDomains": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Read account short domains",
        "description": "Read all short domains available to an account.",
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of the account's short domains.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "example": [
                  "tn.gg"
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/accounts/{accountId}": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Read an account",
        "description": "Read a single account by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested AccountDocument, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountDocument"
                },
                "example": {
                  "id": "UFNCRXfCVM87QNawaE8rrKqc",
                  "createdAt": 1471862431010,
                  "customFields": {
                    "owner": "UEp4rDGsnpCAF6xABbys5Amc"
                  },
                  "updatedAt": 1477652024205,
                  "name": "Test Account Owner",
                  "tfaRequired": false
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "Accounts"
        ],
        "summary": "Update an account",
        "description": "Update an account with new user information, such as new `customFields`.",
        "parameters": [
          {
            "$ref": "#/components/parameters/accountId"
          }
        ],
        "responses": {
          "200": {
            "description": "The updated AccountDocument",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountDocument"
                },
                "example": {
                  "id": "UhpHrg39QCy38dht93kiuwnb",
                  "createdAt": 1471862430889,
                  "customFields": {
                    "owner": "UEp4rDGsnpjdu37d76yg5Amc"
                  },
                  "updatedAt": 1471862431010,
                  "name": "Updated Account Name",
                  "tfaRequired": false
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountDocument"
              },
              "example": {
                "customFields": {
                  "environment": "test"
                }
              }
            }
          },
          "description": "The AccountDocument containing fields to create/update.",
          "required": true
        }
      }
    },
    "/accounts": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "Read all accounts",
        "description": "Get all accounts visible to an Operator with their API key.",
        "responses": {
          "200": {
            "description": "A list of all accessible accounts.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AccountDocument"
                  }
                },
                "example": [
                  {
                    "id": "UFNCRXfCVM87QNawaE8rrKqc",
                    "createdAt": 1471862431010,
                    "customFields": {
                      "owner": "UEp4rDGsnpCAF6xABbys5Amc"
                    },
                    "updatedAt": 1477652024205,
                    "name": "Test Account Owner",
                    "tfaRequired": false,
                    "configuration": {
                      "uniqueIdentifiers": {
                        "products": [
                          "gs1:01",
                          "gs1:22"
                        ]
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/actions/{actionType}/{actionId}": {
      "get": {
        "tags": [
          "Actions"
        ],
        "summary": "Read an action",
        "description": "Read a single action by ID. You can use `all` as an `actionType` to read actions of unknown type.",
        "parameters": [
          {
            "$ref": "#/components/parameters/actionType"
          },
          {
            "$ref": "#/components/parameters/actionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested action, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "createdAt": 1490356832189,
                  "id": "Uk7CwHXaeg8w9KaaagVDhHqq",
                  "location": {
                    "latitude": 51.45,
                    "longitude": 0.2167,
                    "position": {
                      "coordinates": [
                        0.2167,
                        51.45
                      ],
                      "type": "Point"
                    }
                  },
                  "locationSource": "geoIp",
                  "thng": "UkNCRED7BDPaQKRRwhAnPaQn",
                  "timestamp": 1490356832189,
                  "type": "scans"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      },
      "delete": {
        "tags": [
          "Actions"
        ],
        "summary": "Delete an action",
        "description": "Delete an action by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/actionType"
          },
          {
            "$ref": "#/components/parameters/actionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The action was deleted. No body is returned"
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/actions/{actionType}": {
      "post": {
        "tags": [
          "Actions"
        ],
        "summary": "Create an action",
        "description": "Create a new action of the specified type. `all` can be specified as the `actionType`, in which case the specified action type must be supplied in the payload. If no location is specified, the Platform will automatically determine the location based on the IP address of the device who has issued it, along with a country code that is returned in the context object.",
        "parameters": [
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "201": {
            "description": "The newly created action.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "id": "51cac5610c31fcd6f0434a90",
                  "createdAt": 1372243297475,
                  "customFields": {
                    "color": "blue"
                  },
                  "timestamp": 1386322747971,
                  "identifiers": {
                    "sapId": "KDL-46EX402AEP",
                    "event_Id": 48901909
                  },
                  "type": "scans",
                  "user": "51c95a9ae4b08235bfeef378",
                  "createdByProject": "51c95a9ae4b08235bfeef341",
                  "createdByApp": "51c98b6ae4b08235bfeef345",
                  "location": {
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        6.1667,
                        49.75
                      ]
                    }
                  },
                  "locationSource": "geoIp",
                  "context": {
                    "ipAddress": "147.67.4.98",
                    "countryCode": "LU"
                  },
                  "thng": "51c98c28e4b08235bfeef389",
                  "product": "51c98b6ae4b08235bfeef387"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ActionDocument"
              },
              "example": {
                "type": "scans",
                "thng": "Uk7KFKGKBXPwQKawwDYF9bPr"
              }
            }
          },
          "description": "The ActionDocument to create.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Actions"
        ],
        "summary": "Read all actions of a type",
        "description": "Read all actions of the specified `actionType` visible to the authenticating API key. `all` can be used as the `actionType` to view actions of all types.",
        "parameters": [
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "200": {
            "description": "The actions of type requested, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ActionDocument"
                  }
                },
                "example": [
                  {
                    "createdAt": 1489415597321,
                    "createdByApp": "UkMgYtdEVDsaQKaRwgdAWsdn",
                    "createdByProject": "UF5hQHxMBg8a9pwwRYxqXkqp",
                    "customFields": {
                      "ExternalScan": true
                    },
                    "id": "U2MDHNnsVg8RtpRawDDAmFge",
                    "location": {
                      "latitude": 51.748446699999995,
                      "longitude": -0.9656587999999999,
                      "position": {
                        "coordinates": [
                          -0.9656587999999999,
                          51.748446699999995
                        ],
                        "type": "Point"
                      }
                    },
                    "locationSource": "sensor",
                    "product": "UFKE9nHBBg8atKaawgVrKKbs",
                    "thng": "Uk6XkAPbBXPwtKwawDAepMmm",
                    "timestamp": 1489415597321,
                    "type": "scans",
                    "user": "UkqD4NnYBD8a9pawwEsXqrkh"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      },
      "put": {
        "tags": [
          "Actions"
        ],
        "summary": "Update an action type",
        "description": "Update an action type with new metadata.",
        "parameters": [
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "200": {
            "description": "The action type was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionTypeDocument"
                },
                "example": {
                  "id": "UFPMHq2xeDPatpRRwERN2hGm",
                  "createdAt": 1491905665800,
                  "tags": [
                    "updated"
                  ],
                  "updatedAt": 1492521409780,
                  "name": "_permanent"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ActionTypeDocument"
              },
              "example": {
                "tags": [
                  "demo"
                ]
              }
            }
          },
          "description": "Payload for updating an action type.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Actions"
        ],
        "summary": "Delete an action type",
        "description": "Delete an action type.",
        "parameters": [
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "200": {
            "description": "The action type was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/actions": {
      "post": {
        "tags": [
          "Actions"
        ],
        "summary": "Create an action type",
        "description": "Create a new action type.",
        "responses": {
          "201": {
            "description": "The newly created action type.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionTypeDocument"
                },
                "example": {
                  "id": "Uk7WdgFAMQtehsRawgdwEkCn",
                  "createdAt": 1490368131932,
                  "updatedAt": 1490368131932,
                  "name": "_custom"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ActionTypeDocument"
              },
              "example": {
                "name": "_Example",
                "description": "A description of this action type"
              }
            }
          },
          "description": "A action type to create.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Actions"
        ],
        "summary": "Read all action types",
        "description": "Read all action types.  The action types are returned with the built-in types coming first, followed by the custom types sorted by descending creation date.",
        "responses": {
          "200": {
            "description": "All available action types.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ActionTypeDocument"
                  }
                },
                "example": [
                  {
                    "name": "checkins"
                  },
                  {
                    "name": "implicitScans"
                  },
                  {
                    "name": "scans"
                  },
                  {
                    "name": "shares"
                  },
                  {
                    "id": "Uk7WdgFAMQtehsRawgdwEkCn",
                    "createdAt": 1490368131932,
                    "updatedAt": 1490368131932,
                    "name": "_custom"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      }
    },
    "/adis/orders/{adiOrderId}/events/{orderEventId}": {
      "get": {
        "tags": [
          "ADI Orders"
        ],
        "summary": "Read an ADI Order event",
        "description": "Retrieve a single ADI order event by its ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/adiOrderId"
          },
          {
            "$ref": "#/components/parameters/orderEventId"
          },
          {
            "$ref": "#/components/parameters/withErrors"
          }
        ],
        "responses": {
          "200": {
            "description": "The order event was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ADIOrderEventDocument"
                },
                "example": {
                  "id": "UNTrNKg2BMsNt7wRwYymrGhm",
                  "status": {
                    "state": "pending",
                    "requested": 2,
                    "events": {
                      "created": 0,
                      "pending": 1,
                      "errorsCount": 1,
                      "errors": {
                        "ABSDFAFQQRQ": "Failed to create an action"
                      }
                    }
                  },
                  "metadata": {
                    "type": "encodings",
                    "tags": [
                      "example"
                    ]
                  },
                  "ids": [
                    "serial1",
                    "serial2"
                  ],
                  "customFields": {
                    "internalId": "X7JF"
                  },
                  "tags": [
                    "X7JF"
                  ]
                }
              }
            }
          },
          "404": {
            "description": "- ADI Order is not found\n- ADI Order Event is not found\n"
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/adis/orders/{adiOrderId}/events": {
      "post": {
        "tags": [
          "ADI Orders"
        ],
        "summary": "Create an ADI Order event",
        "description": "Creates an event for actions on the ADIs (Thngs) in the specified ADI Order. This request should include the IDs to use when creating the actions.",
        "parameters": [
          {
            "$ref": "#/components/parameters/adiOrderId"
          }
        ],
        "requestBody": {
          "description": "The details of the order event.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ADIOrderEventDocument"
              },
              "example": {
                "metadata": null,
                "type": "encodings",
                "tags": [
                  "example"
                ],
                "ids": [
                  "serial1",
                  "serial2"
                ],
                "customFields": {
                  "internalId": "X7JF"
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The order event was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ADIOrderEventDocument"
                },
                "example": {
                  "metadata": {
                    "type": "encodings",
                    "tags": [
                      "example"
                    ]
                  },
                  "ids": [
                    "serial1",
                    "serial2"
                  ],
                  "customFields": {
                    "internalId": "X7JF"
                  },
                  "tags": [
                    "X7JF"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Unsupported character set.\nID array length is greater than allowed.\nGiven account was not found.\nThe action type doesn't exist in account/targetAccount.\nThere are IDs which were not specified in IDs array of the ADI order.\n"
          },
          "415": {
            "description": "The payload must be valid JSON and the 'Content-type: application/json' header set."
          },
          "423": {
            "description": "Adi Order has not been finished yet"
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "get": {
        "tags": [
          "ADI Orders"
        ],
        "summary": "Read all ADI Order events",
        "description": "Retrieves all ADI Order events belonging to the specified ADI Order",
        "parameters": [
          {
            "$ref": "#/components/parameters/adiOrderId"
          }
        ],
        "responses": {
          "200": {
            "description": "List of ADI order events",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ADIOrderEventDocument"
                  }
                },
                "example": [
                  {
                    "metadata": null,
                    "type": "encodings",
                    "tags": [
                      "example"
                    ],
                    "ids": [
                      "serial1",
                      "serial2"
                    ],
                    "customFields": {
                      "internalId": "X7JF"
                    }
                  }
                ]
              }
            }
          },
          "404": {
            "description": "ADI order not found"
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/adis/orders/{adiOrderId}": {
      "get": {
        "tags": [
          "ADI Orders"
        ],
        "summary": "Read an ADI Order",
        "description": "Retrieve a single ADI order by its ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/adiOrderId"
          }
        ],
        "responses": {
          "200": {
            "description": "The order was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ADIOrderDocument"
                },
                "example": {
                  "id": "UNTrNKg2BMsNt7wRwYymrGhm",
                  "status": {
                    "state": "pending",
                    "requested": 2,
                    "created": 0,
                    "pending": 0,
                    "errorsCount": 0
                  },
                  "purchaseOrder": "234567890",
                  "metadata": {
                    "identifierKey": "gs1:21",
                    "customFields": {
                      "factory": "0400321"
                    },
                    "product": "gs1:01:9780345418913",
                    "tags": [
                      "factory:0400321"
                    ],
                    "shortDomain": "tn.gg",
                    "defaultRedirectUrl": "https://evrythng.com?id={shortId}"
                  },
                  "identifiers": {
                    "internalId": "X7JF"
                  },
                  "tags": [
                    "X7JF"
                  ],
                  "fileMetadata": {
                    "csv": {
                      "digitalLinkDomain": "https://pxpra.tn.gg",
                      "columns": [
                        "product",
                        "identifier",
                        "shortUrl",
                        "digitalLink"
                      ]
                    },
                    "txt": {
                      "digitalLinkDomain": "https://pxpra.tn.gg",
                      "value": "digitalLink",
                      "perLine": 3,
                      "separator": "|",
                      "newLine": "\\r\\n"
                    }
                  },
                  "results": {
                    "identifiers": {
                      "csv": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.csv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2d77b9636382476ed152b848eef3b44dbc75961827a027cafb8dab935e5bd312",
                      "txt": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d176238e2f99a925f6903e1abea25c81a9a719b8cd952cc71c407b5f111463f0",
                      "json": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
                    },
                    "errors": {
                      "json": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/errors-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The order was not found"
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/adis/orders": {
      "post": {
        "tags": [
          "ADI Orders"
        ],
        "summary": "Create an ADI Order",
        "description": "Create an order for new ADI (Thngs). This order should include the IDs to use when generating the ADIs.",
        "requestBody": {
          "description": "The details of the order.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ADIOrderDocument"
              },
              "example": {
                "ids": [
                  "serial1",
                  "serial2"
                ],
                "purchaseOrder": "234567890",
                "metadata": {
                  "identifierKey": "gs1:21",
                  "customFields": {
                    "factory": "0400321"
                  },
                  "product": "gs1:01:9780345418913",
                  "tags": [
                    "factory:0400321"
                  ],
                  "shortDomain": "tn.gg",
                  "defaultRedirectUrl": "https://evrythng.com?id={shortId}"
                },
                "identifiers": {
                  "internalId": "X7JF"
                },
                "tags": [
                  "X7JF"
                ],
                "fileMetadata": {
                  "csv": {
                    "digitalLinkDomain": "https://pxpra.tn.gg",
                    "columns": [
                      "product",
                      "identifier",
                      "shortUrl",
                      "digitalLink"
                    ]
                  },
                  "txt": {
                    "digitalLinkDomain": "https://pxpra.tn.gg",
                    "value": "digitalLink",
                    "perLine": 3,
                    "separator": "|",
                    "newLine": "\\r\\n"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The order was placed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ADIOrderDocument"
                },
                "example": {
                  "id": "UNTrNKg2BMsNt7wRwYymrGhm",
                  "status": {
                    "state": "pending",
                    "requested": 2,
                    "created": 0,
                    "pending": 0,
                    "errorsCount": 0
                  },
                  "purchaseOrder": "234567890",
                  "metadata": {
                    "identifierKey": "gs1:21",
                    "customFields": {
                      "factory": "0400321"
                    },
                    "product": "gs1:01:9780345418913",
                    "tags": [
                      "factory:0400321"
                    ],
                    "shortDomain": "tn.gg",
                    "defaultRedirectUrl": "https://evrythng.com?id={shortId}"
                  },
                  "identifiers": {
                    "internalId": "X7JF"
                  },
                  "tags": [
                    "X7JF"
                  ],
                  "fileMetadata": {
                    "csv": {
                      "digitalLinkDomain": "https://pxpra.tn.gg",
                      "columns": [
                        "product",
                        "identifier",
                        "shortUrl",
                        "digitalLink"
                      ]
                    },
                    "txt": {
                      "digitalLinkDomain": "https://pxpra.tn.gg",
                      "value": "digitalLink",
                      "perLine": 3,
                      "separator": "|",
                      "newLine": "\\r\\n"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Unsupported character set.\nToo many ADIs to be created.\nGiven account was not found.\n"
          },
          "415": {
            "description": "The payload must be valid JSON and the 'Content-type: application/json' header set."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "get": {
        "tags": [
          "ADI Orders"
        ],
        "summary": "Read all ADI Orders",
        "description": "Retrieve a list of ADI Orders.",
        "parameters": [
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/nextPageToken"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was successfull.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ADIOrderDocument"
                  }
                },
                "example": [
                  {
                    "id": "UNTrNKg2BMsNt7wRwYymrGhm",
                    "purchaseOrder": "234567890",
                    "metadata": {
                      "identifierKey": "gs1:21",
                      "customFields": {
                        "factory": "0400321"
                      },
                      "product": "gs1:01:9780345418913",
                      "tags": [
                        "factory:0400321"
                      ],
                      "shortDomain": "tn.gg",
                      "defaultRedirectUrl": "https://evrythng.com?id={shortId}"
                    },
                    "identifiers": {
                      "internalId": "X7JF"
                    },
                    "tags": [
                      "X7JF"
                    ],
                    "fileMetadata": {
                      "csv": {
                        "digitalLinkDomain": "https://pxpra.tn.gg",
                        "columns": [
                          "product",
                          "identifier",
                          "shortUrl",
                          "digitalLink"
                        ]
                      },
                      "txt": {
                        "digitalLinkDomain": "https://pxpra.tn.gg",
                        "value": "digitalLink",
                        "perLine": 3,
                        "separator": "|",
                        "newLine": "\\r\\n"
                      }
                    }
                  }
                ]
              }
            }
          },
          "400": {
            "description": "Bad request. Query parameters provided are incorrect."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/applications/me": {
      "get": {
        "tags": [
          "Applications"
        ],
        "summary": "Read self application",
        "description": "Read the self application of the authenticating Trusted App API Key.",
        "responses": {
          "200": {
            "description": "The authenticating `ApplicationDocument`, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationDocument"
                },
                "example": {
                  "id": "Umbn56MmBDsatpaawg6XgKfk",
                  "createdAt": 1494924489128,
                  "customFields": {},
                  "updatedAt": 1496755229994,
                  "name": "Main Application",
                  "description": "Main Application",
                  "project": "UmxHK6K8BXsa9KawRh4bTbqc",
                  "socialNetworks": {},
                  "appApiKey": "m9xYExkQJNt78BI7676Ftx3TLcpPK5Dbpv2WcSBA...",
                  "defaultRole": "base_app_user"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Trusted Application",
          "Application"
        ]
      },
      "put": {
        "tags": [
          "Applications"
        ],
        "summary": "Update self application",
        "description": "Update the self application of the authenticating Trusted App API Key.",
        "responses": {
          "200": {
            "description": "The application was updated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationDocument"
                },
                "example": {
                  "id": "Umbn56MmBDsatpaawg6XgKfk",
                  "createdAt": 1494924489128,
                  "customFields": {},
                  "updatedAt": 1496755229994,
                  "name": "Main Application",
                  "description": "Main Application",
                  "project": "UmxHK6K8BXsa9KawRh4bTbqc",
                  "socialNetworks": {},
                  "appApiKey": "m9xYExkQJNt78BI7676Ftx3TLcpPK5Dbpv2WcSBA...",
                  "defaultRole": "base_app_user"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationDocument"
              },
              "example": {
                "name": "Test Application",
                "description": "A test application",
                "socialNetworks": {}
              }
            }
          },
          "description": "The ApplicationDocument containing fields to create/update.",
          "required": true
        }
      }
    },
    "/auth/all/logout": {
      "post": {
        "tags": [
          "Application Users"
        ],
        "summary": "Log an Application User out",
        "description": "Log an Application User out and invalidate their Application User API key.",
        "responses": {
          "201": {
            "description": "The Application User was logged out successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserLogoutDocument"
                },
                "example": {
                  "logout": "ok"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Application User"
        ]
      }
    },
    "/auth/evrythng/thngs/{thngId}": {
      "get": {
        "tags": [
          "Thngs"
        ],
        "summary": "Read a Device API Key",
        "description": "Retrieve a Device API key with a Thng's ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Device API key for this Thng, if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthThngDocument"
                },
                "example": {
                  "thngId": "UkNCRED7BDPaQKRRwhAnPaQn",
                  "thngApiKey": "iAmmxHByiwvkSOAlvYxAFGNomeofe54lWgYarilw..."
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ]
      },
      "delete": {
        "tags": [
          "Thngs"
        ],
        "summary": "Delete a Device API Key",
        "description": "Delete a Device API key to revoke access.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Device API key was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ]
      }
    },
    "/auth/evrythng/thngs": {
      "post": {
        "tags": [
          "Thngs"
        ],
        "summary": "Create a Device API Key",
        "description": "Create a Device API key for a Thng to manage its own data. A Device API key can only be created by Application Users or Operators. If called multiple times for the same Thng, the existing API key will be returned (a new one will not be generated). If you want to create a new API key for a Thng, you must delete the existing one first.",
        "responses": {
          "201": {
            "description": "The Device API key was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthThngDocument"
                },
                "example": {
                  "thngId": "UkNCRED7BDPaQKRRwhAnPaQn",
                  "thngApiKey": "iAmmxHByiwvkSOAlvYxAFGNomeofe54lWgYarilw..."
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AuthThngDocument"
              },
              "example": {
                "thngId": "UnXf5gsUMGPEEMwRwF3WcGgd"
              }
            }
          },
          "description": "The request body for creating a Device key.",
          "required": true
        }
      }
    },
    "/auth/evrythng/users/{evrythngUser}/validate": {
      "post": {
        "tags": [
          "Application Users"
        ],
        "summary": "Activate an Application User",
        "description": "Activate a new Application User using the `activationCode` provided in the 'Create an Application User' step.",
        "parameters": [
          {
            "$ref": "#/components/parameters/evrythngUser"
          }
        ],
        "responses": {
          "201": {
            "description": "The Application User was successfully activated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserActivatedDocument"
                },
                "example": {
                  "status": "active",
                  "evrythngUser": "U2r5EyXxVgPRQpwRwhHGCebs",
                  "evrythngApiKey": "hy4auhuQ31YsxvZT7Y2nWbzRg2wKczBzlLGSQakC..."
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Trusted Application",
          "Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ActivationCodeDocument"
              },
              "example": {
                "activationCode": "LIy4ScLy"
              }
            }
          },
          "description": "The request body for activating an unactivated Application User.",
          "required": true
        }
      }
    },
    "/auth/evrythng/users": {
      "post": {
        "tags": [
          "Application Users"
        ],
        "summary": "Create an Application User",
        "description": "Create a new unactivated Application User with a unique email address. The response contains an `activationCode` that must be returned to the API (See 'Activate an Application User') before it can access the API. This gives the client application an opportunity to ensure the email address has been validated.",
        "responses": {
          "201": {
            "description": "The application user was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserActivationDocument"
                },
                "example": {
                  "evrythngUser": "U2N4xqPyVgsa95wRwhFGNmma",
                  "activationCode": "38iVlrnV",
                  "status": "inactive",
                  "email": "test@testers.com"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Trusted Application",
          "Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationUserDocument"
              },
              "example": {
                "firstName": "Test",
                "lastName": "Testers",
                "email": "test@testers.com",
                "password": "P@ssw0rd"
              }
            }
          },
          "description": "The app user to create.",
          "required": true
        }
      }
    },
    "/auth/evrythng": {
      "post": {
        "tags": [
          "Application Users"
        ],
        "summary": "Log an Application User in",
        "description": "Authenticate (log in) an existing user using their original `email` and `password` used at creation time.",
        "responses": {
          "201": {
            "description": "The user was logged in successfully, and a new API key created for this login session.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserLoggedInDocument"
                },
                "example": {
                  "socialNetwork": "evrythng",
                  "evrythngUser": "U2rKMB5QVXsRtKawRhYWDa9f",
                  "evrythngApiKey": "USiVuEFErLJYngR1msPaaOpNNRuOQaiF9Hs4lu8g...",
                  "email": "test@evrythng.com",
                  "status": "active"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Trusted Application",
          "Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationUserLoginDocument"
              },
              "example": {
                "email": "test@email.com",
                "password": "M7@29P6Stk9zF5gX5@4!c3Vm"
              }
            }
          },
          "description": "The Application User's email and password to log in again.",
          "required": true
        }
      }
    },
    "/batches/{batchId}/tasks/{taskId}/logs": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Read task error logs",
        "description": "Read the error logs, if any, for a given task. If not errors occured, there will be no logs.",
        "parameters": [
          {
            "$ref": "#/components/parameters/batchId"
          },
          {
            "$ref": "#/components/parameters/taskId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested task logs, if any errors occured.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TaskLogDocument"
                  }
                },
                "example": [
                  {
                    "jobId": "UnNtxsSSeXPwtpaRa2NqVqKk",
                    "payload": {
                      "shortId": "IDF20170004",
                      "thng": "Un7tb8bdMGPEY6wwahscxh6m",
                      "thngIdentifier": {
                        "key": "shortId",
                        "value": "IDF20170004"
                      },
                      "urlBinding": "UnNtbsbAM3shY6aawhsyShMn"
                    },
                    "type": "ERROR",
                    "message": "Failed to generate UrlBinding for [{shortId='IDF20170004', thng='Un7tb8bdMGPEY6wwahscxh6m', urlBinding='UnNtbsbAM3shY6aawhsyShMn'}]: uniqueness constraint violated."
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/batches/{batchId}/tasks/{taskId}": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Read a batch task",
        "description": "Read a single task for a given batch.",
        "parameters": [
          {
            "$ref": "#/components/parameters/batchId"
          },
          {
            "$ref": "#/components/parameters/taskId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested task, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicTaskDocument"
                },
                "example": {
                  "id": "UG92f3A2MmPEE6wRwhtErd9f",
                  "createdAt": 1509447992783,
                  "updatedAt": 1509447993852,
                  "completedAt": 1509447993852,
                  "batch": "UmNqmfDEBDswtpaaRDs6xHpn",
                  "type": "POPULATING",
                  "status": "EXECUTED",
                  "result": {
                    "type": "POPULATING",
                    "failedOperationsAmount": 0,
                    "location": "https://s3.amazonaws.com/evtcdn_02/2/uf/UmFVekRaVXsa9pRwwYaRDmer/batch-UmNqmfDEBDswtpaaRDs6xHpn-task-Um92fmAkBgswtpRwRXHMFDke3437439154428411976~59f8593963153ae0.zip",
                    "format": "CSV",
                    "totalThngsCreated": 5,
                    "totalUrlBindingsCreated": 5,
                    "totalCount": 10
                  },
                  "inputParameters": {
                    "generateThngs": true,
                    "generateRedirections": true,
                    "shortDomain": "tn.gg",
                    "defaultRedirectUrl": "https://google.com",
                    "thngTemplate": {
                      "tags": [
                        "Generated"
                      ],
                      "name": "List Based Task Thng"
                    },
                    "type": "LIST_BASED",
                    "inputData": [
                      {
                        "shortId": "IDF20170001"
                      },
                      {
                        "shortId": "IDF20170002"
                      },
                      {
                        "shortId": "IDF20170003"
                      },
                      {
                        "shortId": "IDF20170004"
                      },
                      {
                        "shortId": "IDF20170005"
                      }
                    ]
                  },
                  "progress": {
                    "contributions": {
                      "U3QkWGUm6QteEsawwEAVht2b": {
                        "urlBindings": 5,
                        "thngs": 5,
                        "failedUrlBindings": 0,
                        "failedThngs": 0
                      }
                    },
                    "totalAmount": 10
                  }
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/batches/{batchId}/tasks": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "summary": "Create a batch task",
        "description": "Create a task on the specified batch.",
        "parameters": [
          {
            "$ref": "#/components/parameters/batchId"
          }
        ],
        "responses": {
          "202": {
            "description": "The new task was accepted. Check the `Location` header for the URL of the new task."
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FixedAmountTaskDocument"
              },
              "example": {
                "type": "POPULATING",
                "outputParameters": {
                  "type": "CSV",
                  "columns": [
                    "SHORT_ID",
                    "THNG"
                  ]
                },
                "inputParameters": {
                  "type": "FIXED_AMOUNT",
                  "generateThngs": true,
                  "generateRedirections": true,
                  "defaultRedirectUrl": "https://google.com",
                  "thngTemplate": {
                    "name": "Fixed Amount Task Thng",
                    "tags": [
                      "Generated"
                    ]
                  },
                  "shortDomain": "tn.gg",
                  "quantity": 1,
                  "shortIdTemplate": {
                    "type": "THNG_ID"
                  }
                }
              }
            }
          },
          "description": "The TaskDocument to create a `FIXED_AMOUNT` type of task on a batch.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Tasks"
        ],
        "summary": "Read all batch tasks",
        "description": "Read all tasks for a given batch.",
        "parameters": [
          {
            "$ref": "#/components/parameters/batchId"
          }
        ],
        "responses": {
          "200": {
            "description": "All available tasks for this batch.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/BasicTaskDocument"
                  }
                },
                "example": [
                  {
                    "id": "UE9DddW7qnDA8rg4rHHxrsFn",
                    "createdAt": 1475752797109,
                    "updatedAt": 1475752798198,
                    "completedAt": 1475752798198,
                    "batch": "UEtdHPBbmgxypHxWhVKbBbCa",
                    "type": "POPULATING",
                    "status": "EXECUTED",
                    "result": {
                      "type": "POPULATING",
                      "failedOperationsAmount": 0,
                      "location": "https://s3.amazonaws.com/evtcdn_02/2/uf/UhpHrg39QCy9dsSddN8xhwnb/batch-UEtdHPBbmgxypHxWhVKbBbCa-task-UE9gAdf7mWeBKtbAxdkAhbMk452646197797282204~57f6335d2b888118.zip",
                      "format": "CSV",
                      "totalThngsCreated": 10,
                      "totalUrlBindingsCreated": 10,
                      "totalCount": 20
                    },
                    "inputParameters": {
                      "generateThngs": true,
                      "generateRedirections": true,
                      "shortDomain": "tn.gg",
                      "defaultRedirectUrl": "https://developers.evrythng.com",
                      "thngTemplate": {
                        "name": "Batch Thng",
                        "description": "A Thng born from a task on a batch"
                      },
                      "type": "FIXED_AMOUNT",
                      "quantity": 10,
                      "shortIdTemplate": {
                        "type": "THNG_ID"
                      }
                    },
                    "progress": {
                      "contributions": {
                        "Uh9XAAWN9nerWHAfC2x4Cbrg": {
                          "urlBindings": 10,
                          "thngs": 10,
                          "failedUrlBindings": 0,
                          "failedThngs": 0
                        }
                      },
                      "totalAmount": 20
                    }
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/batches/{batchId}": {
      "get": {
        "tags": [
          "Batches"
        ],
        "summary": "Read a batch",
        "description": "Read a single batch by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/batchId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested batch, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BatchDocument"
                },
                "example": {
                  "id": "UkPd3QayMmPEhMawwgaVrwbm",
                  "createdAt": 1491312386545,
                  "updatedAt": 1491312386545,
                  "name": "PermaBatch",
                  "status": "EMPTY"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "Batches"
        ],
        "summary": "Update a batch",
        "description": "Update a batch by ID. Nested fields such as `tags` are replaced with the new value in the payload.",
        "parameters": [
          {
            "$ref": "#/components/parameters/batchId"
          }
        ],
        "responses": {
          "200": {
            "description": "The batch was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BatchDocument"
                },
                "example": {
                  "id": "UkPd3QayMmPEhMawwgaVrwbm",
                  "createdAt": 1491312386545,
                  "updatedAt": 1491312386545,
                  "name": "Updated Batch",
                  "status": "EMPTY"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BatchDocument"
              },
              "example": {
                "name": "Example Batch",
                "description": "Example Batch description."
              }
            }
          },
          "description": "The payload used to create a batch.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Batches"
        ],
        "summary": "Delete a batch",
        "description": "Delete a batch by ID. Deleting the batch will not delete the tasks and Thngs in it, which must be deleted separately.",
        "parameters": [
          {
            "$ref": "#/components/parameters/batchId"
          }
        ],
        "responses": {
          "200": {
            "description": "The batch was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/batches": {
      "post": {
        "tags": [
          "Batches"
        ],
        "summary": "Create a batch",
        "description": "Create a batch.",
        "responses": {
          "201": {
            "description": "The batch was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BatchDocument"
                },
                "example": {
                  "id": "UFsd3nVC6tQBEsRwwDngYcfb",
                  "createdAt": 1491311173775,
                  "updatedAt": 1491311173775,
                  "name": "Batch # R1-5 | 03-2015",
                  "description": "Batch # R1-5 | 03-2015. LEDs for bulbs.",
                  "status": "EMPTY"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BatchDocument"
              },
              "example": {
                "name": "Example Batch",
                "description": "Example Batch description."
              }
            }
          },
          "description": "The payload used to create a batch.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Batches"
        ],
        "summary": "Read all batches",
        "description": "Read all available batches. Use a filter to retrieve a subset of all batches created.",
        "responses": {
          "200": {
            "description": "An array of all available batches, paginated as necessary.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/BatchDocument"
                  }
                },
                "example": [
                  {
                    "id": "UNfMKGGf7kgMsERwwm3bqafe",
                    "createdAt": 1566357909459,
                    "updatedAt": 1566357918733,
                    "name": "Test Batch",
                    "status": "COMPLETE"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/collections/{collectionId}/actions/{actionType}/{actionId}": {
      "get": {
        "tags": [
          "Collections"
        ],
        "summary": "Read a collection action",
        "description": "Read an action on a collection by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          },
          {
            "$ref": "#/components/parameters/actionType"
          },
          {
            "$ref": "#/components/parameters/actionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested action, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "id": "UF8gd9hD6ttBE8awRgNUmafh",
                  "createdAt": 1491484534118,
                  "timestamp": 1491484534118,
                  "type": "_permanent",
                  "location": {
                    "latitude": 51.4519,
                    "longitude": 0.1792,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        0.1792,
                        51.4519
                      ]
                    }
                  },
                  "locationSource": "geoIp",
                  "collection": "UFNq7cbWqGsYhqwaaXcp5cYr"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      }
    },
    "/collections/{collectionId}/actions/{actionType}": {
      "post": {
        "tags": [
          "Collections"
        ],
        "summary": "Create a collection action",
        "description": "Create an action on a collection.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          },
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "201": {
            "description": "The action was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "id": "UkPgUBmABXPwQpaawhKtSCms",
                  "createdAt": 1491481747604,
                  "timestamp": 1491481747604,
                  "type": "_permanent",
                  "location": {
                    "latitude": 51.4519,
                    "longitude": 0.1792,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        0.1792,
                        51.4519
                      ]
                    }
                  },
                  "locationSource": "geoIp",
                  "context": {
                    "ipAddress": "141.0.154.202",
                    "city": "Crayford",
                    "region": "England",
                    "countryCode": "GB",
                    "userAgent": "Mozilla/5.0 (X11; CrOS x86_64 8172.45.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.64 Safari/537.36",
                    "operatingSystemName": "Unknown",
                    "timeZone": "Europe/London"
                  },
                  "collection": "UFNq7cbWqGsYhqwaaXcp5cYr"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ActionDocument"
              },
              "example": {
                "type": "scans"
              }
            }
          },
          "description": "The request body to create an action, which does not include the resource.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Collections"
        ],
        "summary": "Read all collection actions",
        "description": "Read all actions on a collection.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          },
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "200": {
            "description": "Array of all available actions on this collection.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ActionDocument"
                  }
                },
                "example": [
                  {
                    "id": "UF8gd9hD6ttBE8awRgNUmafh",
                    "createdAt": 1491484534118,
                    "timestamp": 1491484534118,
                    "type": "_permanent",
                    "location": {
                      "latitude": 51.4519,
                      "longitude": 0.1792,
                      "position": {
                        "type": "Point",
                        "coordinates": [
                          0.1792,
                          51.4519
                        ]
                      }
                    },
                    "locationSource": "geoIp",
                    "collection": "UFNq7cbWqGsYhqwaaXcp5cYr"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      }
    },
    "/collections/{collectionId}/collections/{childCollectionId}": {
      "delete": {
        "tags": [
          "Collections"
        ],
        "summary": "Remove a collection from a collection",
        "description": "Remove a collection from a parent collection.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          },
          {
            "$ref": "#/components/parameters/childCollectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The child collection was deleted from the parent successfully"
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/collections/{collectionId}/collections": {
      "post": {
        "tags": [
          "Collections"
        ],
        "summary": "Add collections to a collection",
        "description": "Add collections to a collection.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The child collections were added successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "example": [
                "Ukr6sEY7Bg8w9pRawDUgYDdh"
              ]
            }
          },
          "description": "A list of collection IDs to add to the collection.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Collections"
        ],
        "summary": "Read all collections in a collection",
        "description": "Read all collections in a collection.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of all collections available.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CollectionDocument"
                  }
                },
                "example": [
                  {
                    "id": "Ukr6sEY7Bg8w9pRawDUgYDdh",
                    "createdAt": 1490872189534,
                    "updatedAt": 1490872492927,
                    "name": "Child collection",
                    "collections": [
                      "UFNq7cbWqGsYhqwaaXcp5cYr"
                    ]
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      },
      "delete": {
        "tags": [
          "Collections"
        ],
        "summary": "Remove all collections in a collection",
        "description": "Remove all collections from a parent collection.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The collections were successfully deleted from the parent collection."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/collections/{collectionId}/thngs/{thngId}": {
      "delete": {
        "tags": [
          "Collections"
        ],
        "summary": "Remove a Thng from a collection",
        "description": "Remove a Thng from a collection. There is a limit of 500 Thngs removed per API call on collections. If your collection contains more than 500 elements you should consider an iterative solution.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          },
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Thng was successfully deleted."
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      }
    },
    "/collections/{collectionId}/thngs": {
      "put": {
        "tags": [
          "Collections"
        ],
        "summary": "Add Thngs to a collection",
        "description": "Add Thngs to a collection. The maximum number of Thngs that can be added to a collection is 10,000 per request.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Thngs were added successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionDocument"
                },
                "example": {
                  "id": "UFNq7cbWqGsYhqwaaXcp5cYr",
                  "createdAt": 1490866709256,
                  "scopes": {
                    "users": [],
                    "projects": []
                  },
                  "updatedAt": 1490869890727,
                  "name": "New collection name",
                  "description": "New collection description"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "example": [
                "UkNCRED7BDPaQKRRwhAnPaQn"
              ]
            }
          },
          "description": "A list of Thng IDs to add to the collection.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Collections"
        ],
        "summary": "Read all Thngs in a collection",
        "description": "Read all Thngs in a collection.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of Thngs in this collection, if any.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ThngDocument"
                  }
                },
                "example": [
                  {
                    "id": "UkNCRED7BDPaQKRRwhAnPaQn",
                    "createdAt": 1490356077941,
                    "updatedAt": 1490869117923,
                    "name": "Action Thng",
                    "collections": [
                      "UFNq7cbWqGsYhqwaaXcp5cYr"
                    ]
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      },
      "delete": {
        "tags": [
          "Collections"
        ],
        "summary": "Remove all Thngs from a collection",
        "description": "Remove all Thngs from a collection. Note that this does not delete the actual Thngs themselves.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "All Thngs in the collection were deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/collections/{collectionId}": {
      "get": {
        "tags": [
          "Collections"
        ],
        "summary": "Read a collection",
        "description": "Read a single collection by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection requested, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionDocument"
                },
                "example": {
                  "id": "UF7MqQQsVXPatpaawYgnnbqh",
                  "createdAt": 1490866174655,
                  "updatedAt": 1490866174655,
                  "name": "Test collection"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      },
      "put": {
        "tags": [
          "Collections"
        ],
        "summary": "Update a collection",
        "description": "Update a collection by ID. Nested fields such as `tags` are replaced with the new version in the payload. There is a limit of 10,000 Thngs updated per API call on collections. If your collection contains more than 10,000 elements you should consider an iterative solution.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionDocument"
                },
                "example": {
                  "id": "U2a4AsGtqerbcWD6qhYGfb5d",
                  "createdAt": 1477066399168,
                  "updatedAt": 1490867727562,
                  "name": "Test collection",
                  "description": "test description"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionDocument"
              },
              "example": {
                "name": "Test collection name",
                "description": "Test collection description"
              }
            }
          },
          "description": "The request body for updating a collection.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Collections"
        ],
        "summary": "Delete a collection",
        "description": "Delete a collection by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/collectionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/collections": {
      "post": {
        "tags": [
          "Collections"
        ],
        "summary": "Create a collection",
        "description": "Create a new collection. Resources can then be added to that collection with further `PUT` requests specifying the collection ID.",
        "responses": {
          "201": {
            "description": "The collection was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionDocument"
                },
                "example": {
                  "id": "UF7MqQQsVXPatpaawYgnnbqh",
                  "createdAt": 1490866174655,
                  "updatedAt": 1490866174655,
                  "name": "Test collection"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionDocument"
              },
              "example": {
                "name": "Test collection"
              }
            }
          },
          "description": "The request body for creating a collection.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Collections"
        ],
        "summary": "Read all collections",
        "description": "Read all collections available in an account.",
        "responses": {
          "200": {
            "description": "A list of all visible collections.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CollectionDocument"
                  }
                },
                "example": [
                  {
                    "id": "UhQqMkEnymeMe3xUBWcKAmwk",
                    "createdAt": 1476184186458,
                    "updatedAt": 1476184186458,
                    "name": "A collection"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User",
          "Trusted Application"
        ]
      }
    },
    "/files/{fileId}": {
      "get": {
        "tags": [
          "Files"
        ],
        "summary": "Read a file",
        "description": "Read a single remote file metadata item by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/fileId"
          }
        ],
        "responses": {
          "200": {
            "description": "The remote file metadata item, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FileDocument"
                },
                "example": {
                  "id": "UkPeHkqmeD8wtKawwDMdnxnf",
                  "createdAt": 1491380425930,
                  "updatedAt": 1491380425930,
                  "uploadUrl": "https://s3.amazonaws.com/evtcdn_02/2/uf/UFNCRXfCVM87QNawaE8rrKqc/my_file1.txt?AWSAccessKeyId=AKIAID2MOF7RYNLLMH7Q&Expires=1491383003&Signature=sUVXcEsNDwfxaPCJ63Tj%2FCgbHEE%3D",
                  "contentUrl": "https://s3.amazonaws.com/evtcdn_02/2/uf/UFNCRXfCVM87QNawaE8rrKqc/my_file1.txt?AWSAccessKeyId=AKIAID2MOF7RYNLLMH7Q&Expires=1491383004&Signature=zlQMxyrcfj%2Bbs7ftVVtunQI3np0%3D",
                  "name": "my_file1.txt",
                  "type": "text/plain",
                  "privateAccess": true
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "delete": {
        "tags": [
          "Files"
        ],
        "summary": "Delete a file",
        "description": "Delete a single remote file metadata item by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/fileId"
          }
        ],
        "responses": {
          "200": {
            "description": "The remote file metadata item was deleted."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/files": {
      "post": {
        "tags": [
          "Files"
        ],
        "summary": "Create a file",
        "description": "Create remote file metadata. This operation is the basis for a remote file upload. A successful HTTP `POST` will create a `FileDocument` record with a unique ID and a transient `uploadUrl` field. This signed `uploadUrl` can then be used by a client with an HTTP `PUT` request to do the actual upload to remote storage. The `uploadUrl` will expire after 30 minutes. The input payload to this endpoint should also contain a setting for the `privateAccess` field to indicate whether the file should have 'private' or 'public' access on remote storage.",
        "responses": {
          "201": {
            "description": "The file metadata was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FileDocument"
                },
                "example": {
                  "id": "UkPeHkqmeD8wtKawwDMdnxnf",
                  "createdAt": 1491380425930,
                  "updatedAt": 1491380425930,
                  "uploadUrl": "https://s3.amazonaws.com/evtcdn_02/2/uf/UFNCRXfCVM87QNawaE8rrKqc/my_file1.txt?AWSAccessKeyId=AKIAID2MOF7RYNLLMH7Q&Expires=1491382225&Signature=3ejA8lyO%2BE8Lmlr%2BDScYIwj%2FhI8%3D",
                  "name": "my_file1.txt",
                  "type": "text/plain",
                  "privateAccess": true
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FileDocument"
              },
              "example": {
                "name": "my_file1.txt",
                "type": "text/plain",
                "privateAccess": true
              }
            }
          },
          "description": "The request body for creating a new file metadata.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Files"
        ],
        "summary": "Read all files",
        "description": "Read all remote file metadata items.",
        "responses": {
          "200": {
            "description": "An array of all available remote file metadata items.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/FileDocument"
                  }
                },
                "example": [
                  {
                    "id": "UkPeHkqmeD8wtKawwDMdnxnf",
                    "createdAt": 1491380425930,
                    "updatedAt": 1491380425930,
                    "uploadUrl": "https://s3.amazonaws.com/evtcdn_02/2/uf/UFNCRXfCVM87QNawaE8rrKqc/my_file1.txt?AWSAccessKeyId=AKIAID2MOF7RYNLLMH7Q&Expires=1491382548&Signature=fzT9tMYjYO%2FIW4tS5XDJKLa6ZLM%3D",
                    "contentUrl": "https://s3.amazonaws.com/evtcdn_02/2/uf/UFNCRXfCVM87QNawaE8rrKqc/my_file1.txt?AWSAccessKeyId=AKIAID2MOF7RYNLLMH7Q&Expires=1491382548&Signature=80vZzPVpo%2F83yCKfbRA0Sbunhpo%3D",
                    "name": "my_file1.txt",
                    "type": "text/plain",
                    "privateAccess": true
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/machineLearning/models/{modelType}/{modelId}/datasets/{datasetId}": {
      "get": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Read a training dataset",
        "description": "Read a training dataset by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          },
          {
            "$ref": "#/components/parameters/modelId"
          },
          {
            "$ref": "#/components/parameters/datasetId"
          }
        ],
        "responses": {
          "200": {
            "description": "The dataset was read successfully.",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "$ref": "#/components/schemas/UnknownDocument"
                }
              }
            }
          }
        }
      },
      "put": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Update a training dataset",
        "description": "Updates a dataset and calls this endpoint when the update is complete.",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          },
          {
            "$ref": "#/components/parameters/modelId"
          },
          {
            "$ref": "#/components/parameters/datasetId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "example": {},
              "schema": {
                "$ref": "#/components/schemas/DatasetCallbackDocument"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The dataset was updated successfully.",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "$ref": "#/components/schemas/DatasetCallbackDocument"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/machineLearning/models/{modelType}/{modelId}/datasets": {
      "get": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Read all training datasets",
        "description": "Read a list of training datasets.",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          },
          {
            "$ref": "#/components/parameters/modelId"
          }
        ],
        "responses": {
          "200": {
            "description": "The dataset was read successfully",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "$ref": "#/components/schemas/UnknownDocument"
                }
              }
            }
          }
        }
      },
      "post": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Create a Training Dataset",
        "description": "Creates a training data set. The dataset is described as an EVRYTHNG URL",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          },
          {
            "$ref": "#/components/parameters/modelId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "example": {},
              "schema": {
                "$ref": "#/components/schemas/DatasetDefinitionDocument"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The dataset was created successfully.",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "$ref": "#/components/schemas/DatasetDefinitionDocument"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/machineLearning/models/{modelType}/{modelId}/deployments/{deploymentId}/predict": {
      "post": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Creating a new prediction",
        "description": "Create a Prediction",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          },
          {
            "$ref": "#/components/parameters/modelId"
          },
          {
            "$ref": "#/components/parameters/deploymentId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PredictionPayloadDocument"
              },
              "example": {
                "data": [
                  {
                    "id": "Upt3AYbSny3VatRRwGxSdkee",
                    "createdAt": 1543059217046,
                    "timestamp": 1543059217046,
                    "type": "implicitScans",
                    "user": "10ff93f061029f0a20273005",
                    "location": {
                      "latitude": 51.4779,
                      "longitude": -0.0118,
                      "position": {
                        "type": "Point",
                        "coordinates": [
                          -0.0118,
                          51.4779
                        ]
                      }
                    },
                    "locationSource": "geoIp",
                    "context": {
                      "city": "Greenwich",
                      "region": "England",
                      "countryCode": "GB",
                      "userAgent": "Wget/1.19.5 (darwin17.5.0)",
                      "timeZone": "Europe/London"
                    },
                    "createdByProject": "10ff93f061029f0a20273005",
                    "createdByApp": "10ff93f061029f1a20273005",
                    "thng": "UKPcKYGCrbkSqFRaakRbTesr",
                    "product": "U5egb3EkVg8a9pRaw3mSDbQd"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "THe prediction was created successfully",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "$ref": "#/components/schemas/PredictionPayloadDocument"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/machineLearning/models/{modelType}/{modelId}/deployments/{deploymentId}": {
      "get": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Read a model deployment",
        "description": "Returns metadata about a model deployment.",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          },
          {
            "$ref": "#/components/parameters/modelId"
          },
          {
            "$ref": "#/components/parameters/deploymentId"
          }
        ],
        "responses": {
          "200": {
            "description": "The deployment was read successfully.",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "$ref": "#/components/schemas/UnknownDocument"
                }
              }
            }
          }
        }
      }
    },
    "/machineLearning/models/{modelType}/{modelId}/deployments": {
      "get": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Read all deployed models",
        "description": "Returns a list of deployed models",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          },
          {
            "$ref": "#/components/parameters/modelId"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of deployments was read successfully.",
            "content": {
              "application/json": {
                "example": [
                  "1223",
                  "23432",
                  "2345asd"
                ],
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "x-api-status": "Alpha",
        "summary": "Create a new model deployment",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "description": "Create a new model deployment of the specified model type.",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          },
          {
            "$ref": "#/components/parameters/modelId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "example": {},
              "schema": {
                "$ref": "#/components/schemas/DeploymentConfigDocument"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The deployment was created successfully.",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "$ref": "#/components/schemas/DeploymentConfigDocument"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "example": {},
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/machineLearning/models/{modelType}/{modelId}": {
      "get": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Read a model instance",
        "description": "Returns metadata for a given deployed model.",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          },
          {
            "$ref": "#/components/parameters/modelId"
          }
        ],
        "responses": {
          "200": {
            "description": "The model instance was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnknownDocument"
                },
                "example": {}
              }
            }
          }
        }
      }
    },
    "/machineLearning/models/{modelType}": {
      "get": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Read a model type",
        "description": "Returns a list of model instances. If the query parameter context is set to true, it returns information about the model type.",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          }
        ],
        "responses": {
          "200": {
            "description": "The model type was read successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnknownDocument"
                },
                "example": {}
              }
            }
          }
        }
      },
      "put": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Update a model type",
        "description": "Update a single model type.",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ModelTypePayloadDocument"
              },
              "example": {
                "name": "scans"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The model type was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModelTypePayloadDocument"
                },
                "example": {}
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {}
              }
            }
          }
        }
      },
      "post": {
        "x-api-status": "Alpha",
        "summary": "Create a new model of type",
        "description": "Create a new instance of a model type",
        "parameters": [
          {
            "$ref": "#/components/parameters/modelType"
          }
        ],
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "responses": {
          "200": {
            "description": "The new model was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnknownDocument"
                },
                "example": {}
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {}
              }
            }
          }
        }
      }
    },
    "/machineLearning/models": {
      "get": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "responses": {
          "200": {
            "description": "Returns a list of model types.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "example": [
                  "scanningAnomalies",
                  "supplychainIntegrityChecks"
                ]
              }
            }
          }
        },
        "summary": "Read all model types",
        "description": "Returns a list of model types that can be activated by customers."
      },
      "post": {
        "x-api-status": "Alpha",
        "tags": [
          "Predictor"
        ],
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "summary": "Create a model type",
        "description": "Creates a new model type.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ModelTypePayloadDocument"
              },
              "example": {
                "name": "abnormalScans"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The new model was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModelTypePayloadDocument"
                },
                "example": {}
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/me": {
      "get": {
        "summary": "Get the caller's own account Operator access and inline policies",
        "description": "Reads and returns account operator access and inline policies based on the caller's API key.",
        "tags": [
          "Enterprise Access"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeDocument"
                },
                "example": {
                  "id": "Ud6TycDekE5afp6M8QAEEMhp",
                  "operator": "123932QJ1235823412S741WG4",
                  "name": "first last",
                  "email": "operator@email.com",
                  "description": "access description",
                  "policies": [
                    {
                      "name": "FactoryAdministratorPolicy",
                      "description": "Description of FactoryAdministratorPolicy",
                      "permissions": [
                        "actions:create",
                        "places:list,read,update",
                        "operatorAccess:list,read,update",
                        "products:list,read",
                        "purchaseOrders:list,read",
                        "thngs:read"
                      ],
                      "uiPermissions": [
                        "activation",
                        "authenticate"
                      ],
                      "homepage": "authenticate",
                      "identifiers": {
                        "ean": "aen232032"
                      },
                      "tags": [
                        "roles",
                        "and",
                        "permissions"
                      ]
                    },
                    {
                      "name": "BrandProtector",
                      "permissions": [
                        "actions:create",
                        "products:list,read",
                        "purchaseOrders:list,read",
                        "thngs:read"
                      ],
                      "uiPermissions": [
                        "brandProtection",
                        "authenticate"
                      ],
                      "homepage": "brandProtection"
                    }
                  ],
                  "conditions": [
                    "places:UPBCycCpgVGArgYc5y5UnkAg"
                  ]
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 403,
                  "errors": [
                    "This API is only supported for operators"
                  ],
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-and-error-codes#section-error-codes"
                }
              }
            }
          }
        }
      }
    },
    "/places/{placeId}": {
      "get": {
        "tags": [
          "Places"
        ],
        "summary": "Read a place",
        "description": "Read a place by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/placeId"
          }
        ],
        "responses": {
          "200": {
            "description": "The place that was requested, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlaceDocument"
                },
                "example": {
                  "id": "U2rNbKSxBgsRQpaawhPnCc5d",
                  "createdAt": 1490885393724,
                  "updatedAt": 1491314202340,
                  "name": "Permanent Place",
                  "description": "New description",
                  "position": {
                    "type": "Point",
                    "coordinates": [
                      -0.0882956,
                      51.5303183
                    ]
                  },
                  "address": {
                    "street": "East Road",
                    "postalCode": "N1 6FB",
                    "city": "London",
                    "countryCode": "GB"
                  },
                  "longitude": -0.0882956,
                  "latitude": 51.5303183
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application",
          "Application User"
        ]
      },
      "put": {
        "tags": [
          "Places"
        ],
        "summary": "Update a place",
        "description": "Update a place by ID. The old fields are entirely overwritten by the new values, so to add a tag for example you must submit the previous tag array including the new tags.",
        "parameters": [
          {
            "$ref": "#/components/parameters/placeId"
          }
        ],
        "responses": {
          "200": {
            "description": "The place was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlaceDocument"
                },
                "example": {
                  "id": "U2rNbKSxBgsRQpaawhPnCc5d",
                  "createdAt": 1490885393724,
                  "updatedAt": 1490885393724,
                  "name": "Permanent Place",
                  "description": "London HQ",
                  "icon": "https://evrythng.com/wp-content/themes/evrythng_v2.4/img/logo.svg",
                  "position": {
                    "type": "Point",
                    "coordinates": [
                      -0.0882956,
                      51.5303183
                    ]
                  },
                  "address": {
                    "extension": "Unit 4, 122",
                    "street": "East Road",
                    "postalCode": "N1 6FB",
                    "city": "London",
                    "countryCode": "GB"
                  },
                  "latitude": 51.5303183,
                  "longitude": -0.0882956
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PlaceDocument"
              },
              "example": {
                "description": "New description"
              }
            }
          },
          "description": "The request body for updating a place.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Places"
        ],
        "summary": "Delete a place",
        "description": "Delete a place by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/placeId"
          }
        ],
        "responses": {
          "200": {
            "description": "The place was successfully deleted."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/places": {
      "post": {
        "tags": [
          "Places"
        ],
        "summary": "Create a place",
        "description": "Create a new place.",
        "responses": {
          "201": {
            "description": "The place was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PlaceDocument"
                },
                "example": {
                  "id": "UkrNxSAaVD8wQpaaaDTRKtkp",
                  "createdAt": 1490882864661,
                  "updatedAt": 1490882864661,
                  "name": "Evrythng London Office",
                  "description": "London HQ",
                  "icon": "https://evrythng.com/wp-content/themes/evrythng_v2.4/img/logo.svg",
                  "position": {
                    "type": "Point",
                    "coordinates": [
                      -0.0882956,
                      51.5303183
                    ]
                  },
                  "address": {
                    "extension": "Unit 4, 122",
                    "street": "East Road",
                    "postalCode": "N1 6FB",
                    "city": "London",
                    "countryCode": "GB"
                  },
                  "latitude": 51.5303183,
                  "longitude": -0.0882956
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PlaceDocument"
              },
              "example": {
                "name": "Evrythng London Office",
                "position": {
                  "type": "Point",
                  "coordinates": [
                    -0.0882956,
                    51.5303183
                  ]
                },
                "address": {
                  "extension": "Unit 4, 122",
                  "street": "East Road",
                  "postalCode": "N1 6FB",
                  "city": "London",
                  "countryCode": "GB"
                },
                "description": "London HQ",
                "icon": "https://evrythng.com/wp-content/themes/evrythng_v2.4/img/logo.svg"
              }
            }
          }
        }
      },
      "get": {
        "tags": [
          "Places"
        ],
        "summary": "Read all places",
        "description": "Read all places in an account, with an optional search origin and distance.",
        "parameters": [
          {
            "$ref": "#/components/parameters/latitude"
          },
          {
            "$ref": "#/components/parameters/longitude"
          },
          {
            "$ref": "#/components/parameters/maxDistance"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of all visible places in the account.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PlaceDocument"
                  }
                },
                "example": [
                  {
                    "id": "UFR3PBUe7a2xDnbXQGYVnrGh",
                    "createdAt": 1477043252443,
                    "updatedAt": 1477043252443,
                    "name": "Evrythng London Office",
                    "description": "London HQ",
                    "icon": "https://evrythng.com/wp-content/themes/evrythng_v2.4/img/logo.svg",
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        125.6,
                        10.1
                      ]
                    },
                    "address": {
                      "extension": "Unit 4, 122",
                      "street": "East Road",
                      "postalCode": "N1 6FB",
                      "city": "London",
                      "countryCode": "GB"
                    },
                    "latitude": 10.1,
                    "longitude": 125.6
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application",
          "Application User"
        ]
      }
    },
    "/products/{productId}/actions/{actionType}/{actionId}": {
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Read a product action",
        "description": "Read an action on a product by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          },
          {
            "$ref": "#/components/parameters/actionType"
          },
          {
            "$ref": "#/components/parameters/actionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested action, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "id": "UF8gd9hD6ttBE8awRgNUmafh",
                  "createdAt": 1491484534118,
                  "timestamp": 1491484534118,
                  "type": "_permanent",
                  "location": {
                    "latitude": 51.4519,
                    "longitude": 0.1792,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        0.1792,
                        51.4519
                      ]
                    }
                  },
                  "locationSource": "geoIp",
                  "product": "UFNPxXxwVDPRQpaRwYPttarb"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ]
      }
    },
    "/products/{productId}/actions/{actionType}": {
      "post": {
        "tags": [
          "Products"
        ],
        "summary": "Create a product action",
        "description": "Create an action on a product.",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          },
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "201": {
            "description": "The action was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "id": "UkPgUBmABXPwQpaawhKtSCms",
                  "createdAt": 1491481747604,
                  "timestamp": 1491481747604,
                  "type": "_permanent",
                  "location": {
                    "latitude": 51.4519,
                    "longitude": 0.1792,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        0.1792,
                        51.4519
                      ]
                    }
                  },
                  "locationSource": "geoIp",
                  "context": {
                    "ipAddress": "141.0.154.202",
                    "city": "Crayford",
                    "region": "England",
                    "countryCode": "GB",
                    "userAgent": "Mozilla/5.0 (X11; CrOS x86_64 8172.45.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.64 Safari/537.36",
                    "operatingSystemName": "Unknown",
                    "timeZone": "Europe/London"
                  },
                  "product": "UFNPxXxwVDPRQpaRwYPttarb"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ActionDocument"
              },
              "example": {
                "type": "scans"
              }
            }
          },
          "description": "The request body to create an action, which does not include the resource.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Read all product actions",
        "description": "Read all actions created on a product.",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          },
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "200": {
            "description": "Array of all available actions on this product.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ActionDocument"
                  }
                },
                "example": [
                  {
                    "id": "UF8gd9hD6ttBE8awRgNUmafh",
                    "createdAt": 1491484534118,
                    "timestamp": 1491484534118,
                    "type": "_permanent",
                    "location": {
                      "latitude": 51.4519,
                      "longitude": 0.1792,
                      "position": {
                        "type": "Point",
                        "coordinates": [
                          0.1792,
                          51.4519
                        ]
                      }
                    },
                    "locationSource": "geoIp",
                    "product": "UFNPxXxwVDPRQpaRwYPttarb"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ]
      }
    },
    "/products/{productId}/properties/{propertyKey}": {
      "get": {
        "tags": [
          "Properties"
        ],
        "summary": "Read a product property",
        "description": "Read a single product property. By default, all the updates of this property are returned using pagination in a reverse history fashion (the first element of the returned array is the latest update). For accessing only a subset of all the updates to a single property, you can specify a time range using `?from=Timestamp` and `?to=Timestamp` to specify respectively the beginning and end of the time window. You will receive an array of all the property updates during this time.",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          },
          {
            "$ref": "#/components/parameters/propertyKey"
          },
          {
            "$ref": "#/components/parameters/from"
          },
          {
            "$ref": "#/components/parameters/to"
          }
        ],
        "responses": {
          "200": {
            "description": "The property was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PropertyDocument"
                  }
                },
                "example": [
                  {
                    "createdAt": 1490956152587,
                    "timestamp": 1490956152587,
                    "value": 33
                  },
                  {
                    "createdAt": 1490956151587,
                    "timestamp": 1490956151587,
                    "value": 38
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application",
          "Application User"
        ]
      },
      "put": {
        "tags": [
          "Properties"
        ],
        "summary": "Update a product property",
        "description": "Update a single property by `key`.",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          },
          {
            "$ref": "#/components/parameters/propertyKey"
          }
        ],
        "responses": {
          "200": {
            "description": "The single property update was applied successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PropertiesDocument"
                },
                "example": [
                  {
                    "createdAt": 1490956159587,
                    "timestamp": 1490956159587,
                    "key": "temperature_celcius",
                    "value": 33
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PropertiesDocument"
              },
              "example": [
                {
                  "key": "test_key",
                  "value": 33
                }
              ]
            }
          },
          "description": "The request body for updating a single property.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Properties"
        ],
        "summary": "Delete a product property",
        "description": "Delete a product property. Property updates are not uniquely identified (do not have their own URL). Therefore, the only way to delete data points is to append the `?to=Timestamp` URL query parameter to specify a point in time before which all the data points will be removed. If the `?to=` parameter is not specified, ALL updates of this property will be deleted!",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          },
          {
            "$ref": "#/components/parameters/propertyKey"
          },
          {
            "$ref": "#/components/parameters/to"
          }
        ],
        "responses": {
          "200": {
            "description": "The property was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ]
      }
    },
    "/products/{productId}/properties": {
      "post": {
        "tags": [
          "Properties"
        ],
        "summary": "Create/update product properties",
        "description": "Create/update a product's properties. When a resource is created, you can specify an initial set of properties and their values. To update those properties or to add new ones, use a `PUT` request with an array of `PropertyDocument` JSON objects containing the changed fields. If the properties updated do not exist, they are created automatically by this request and no error/notification will be returned.",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          }
        ],
        "responses": {
          "200": {
            "description": "The property updates were applied successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PropertiesDocument"
                },
                "example": [
                  {
                    "createdAt": 1490953506826,
                    "timestamp": 1490953506826,
                    "key": "temperature_celsius",
                    "value": 33
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PropertiesDocument"
              },
              "example": [
                {
                  "key": "test_key",
                  "value": 33
                }
              ]
            }
          },
          "description": "The request body for updating properties.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Properties"
        ],
        "summary": "Read product properties",
        "description": "Read all properties on a product. The returned payload is the complete array of all the properties with the last value of each.",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of properties of this product.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PropertiesDocument"
                },
                "example": [
                  {
                    "createdAt": 1490955243760,
                    "timestamp": 1490955243760,
                    "key": "temperature_celsius",
                    "value": 33
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application",
          "Application User"
        ]
      }
    },
    "/products/{productId}": {
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Read a product",
        "description": "Read a single product.",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          }
        ],
        "responses": {
          "200": {
            "description": "The product was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductDocument"
                },
                "example": {
                  "id": "UFrPSfP3M9QBEsRaaXtEBAca",
                  "createdAt": 1490949609559,
                  "updatedAt": 1490949609559,
                  "fn": "Test product",
                  "name": "Test product"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application",
          "Application User"
        ]
      },
      "put": {
        "tags": [
          "Products"
        ],
        "summary": "Update a product",
        "description": "Update a product by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          }
        ],
        "responses": {
          "200": {
            "description": "The product was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductDocument"
                },
                "example": {
                  "id": "UFNPxXxwVDPRQpaRwYPttarb",
                  "createdAt": 1490949648401,
                  "updatedAt": 1490950974202,
                  "description": "Updated description",
                  "fn": "Permaproduct",
                  "name": "Permaproduct"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductDocument"
              },
              "example": {
                "description": "Test updated description"
              }
            }
          },
          "description": "The request body for updating a product.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Products"
        ],
        "summary": "Delete a product",
        "description": "Delete a product by ID. Deleting a product resource will remove its reference from all Thngs that point to it. This cannot be reversed!",
        "parameters": [
          {
            "$ref": "#/components/parameters/productId"
          }
        ],
        "responses": {
          "200": {
            "description": "The product was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/products": {
      "post": {
        "tags": [
          "Products"
        ],
        "summary": "Create a product",
        "description": "Create a new product. The ID returned can be then stored in the `product` field of any Thng in the platform, which denotes that that Thng is a unique instance of this particular product.",
        "responses": {
          "201": {
            "description": "The product was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductDocument"
                },
                "example": {
                  "id": "UF7sxeAnMmsEhMaRaEDPcBee",
                  "createdAt": 1490949178881,
                  "updatedAt": 1490949178881,
                  "fn": "Test product",
                  "name": "Test product"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProductDocument"
              },
              "example": {
                "name": "Test product"
              }
            }
          },
          "description": "The request body for creating a product.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Read all products",
        "description": "Read all products in the account.",
        "responses": {
          "200": {
            "description": "An array of all products available.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ProductDocument"
                  }
                },
                "example": [
                  {
                    "id": "UFNPxXxwVDPRQpaRwYPttarb",
                    "createdAt": 1490949648401,
                    "updatedAt": 1490949648401,
                    "fn": "Permaproduct",
                    "name": "Permaproduct"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application",
          "Application User"
        ]
      }
    },
    "/projects/{projectId}/applications/{applicationId}/oauthClients/{clientId}": {
      "get": {
        "tags": [
          "OAuth"
        ],
        "summary": "Read an OAuth client",
        "description": "Read a specific OAuth client by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          },
          {
            "$ref": "#/components/parameters/clientId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested OAuth client, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuthClientDocument"
                },
                "example": {
                  "id": "AbOfZyGinxSOSCx889b5YlVX9db8nBBth52Ndw4Egd1Er",
                  "name": "Updated Example Client",
                  "redirectUrl": "https://examples.com/oauth/updated/callback",
                  "customFields": {
                    "type": "Web Application",
                    "homeUrl": "https://examples.com/updated"
                  },
                  "createdAt": 1476451299788,
                  "updatedAt": 1476452882154
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "OAuth"
        ],
        "summary": "Update an OAuth client",
        "description": "Update an OAuth client by ID. As soon as the redirect URL is modified, the old URL is not used for a user's redirection.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          },
          {
            "$ref": "#/components/parameters/clientId"
          }
        ],
        "responses": {
          "200": {
            "description": "The OAuthClientDocument was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuthClientDocument"
                },
                "example": {
                  "id": "AbOfZyGinxSOSCx889b5YlVX9db8nBBth52Ndw4Egd1Er",
                  "name": "Updated Example Client",
                  "redirectUrl": "https://examples.com/oauth/updated/callback",
                  "customFields": {
                    "a": "field"
                  },
                  "createdAt": 1476451299788,
                  "updatedAt": 1493818580874
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OAuthClientDocument"
              },
              "example": {
                "customFields": {
                  "example": "field"
                }
              }
            }
          },
          "description": "The request body to update an OAuth client.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "OAuth"
        ],
        "summary": "Delete an OAuth client",
        "description": "Delete an OAuth client by ID. After the client is removed, it is not allowed to obtain the Application User access token anymore.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          },
          {
            "$ref": "#/components/parameters/clientId"
          }
        ],
        "responses": {
          "200": {
            "description": "The OAuth client was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/projects/{projectId}/applications/{applicationId}/oauthClients": {
      "post": {
        "tags": [
          "OAuth"
        ],
        "summary": "Create an OAuth client",
        "description": "Registers a new OAuth client.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "201": {
            "description": "The OAuth client was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OAuthClientDocument"
                },
                "example": {
                  "id": "A5OQjkABzTCR3gkoGHybC8tsKOn5bMlQ7O9xpQylXxPQr",
                  "name": "Example Client",
                  "redirectUrl": "https://examples.com/oauth/callback",
                  "customFields": {
                    "type": "Web Application",
                    "homeUrl": "https://examples.com"
                  },
                  "createdAt": 1493815665131,
                  "updatedAt": 1493815665131
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OAuthClientDocument"
              },
              "example": {
                "name": "Example Client",
                "redirectUrl": "https://examples.com/oauth/callback",
                "customFields": {
                  "type": "Web Application",
                  "homeUrl": "https://examples.com"
                }
              }
            }
          },
          "description": "The request body to create an OAuth client.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "OAuth"
        ],
        "summary": "Read all OAuth clients",
        "description": "Read all registered OAuth clients in an application.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of all registered OAuth clients in scope.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/OAuthClientDocument"
                  }
                },
                "example": [
                  {
                    "id": "A5OQjkABzTCR3gkoGHybC8tsKOn5bMlQ7O9xpQylXxPQr",
                    "name": "Example Client",
                    "redirectUrl": "https://examples.com/oauth/callback",
                    "customFields": {
                      "type": "Web Application",
                      "homeUrl": "https://examples.com"
                    },
                    "createdAt": 1493815665131,
                    "updatedAt": 1493815665131
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/projects/{projectId}/applications/{applicationId}/reactor/logs": {
      "get": {
        "tags": [
          "Reactor"
        ],
        "summary": "Read Reactor logs",
        "description": "Read the Reactor logs.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "Available Reactor logs.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ReactorLogEntryDocument"
                  }
                },
                "example": [
                  {
                    "id": "UFPDx6fAVXPaQKwawXdC6mUp",
                    "createdAt": 1491475539795,
                    "timestamp": 1491475539795,
                    "logLevel": "trace",
                    "message": "Reactor script is about to execute. Function name: onScheduledEvent",
                    "app": "Uk7KFKGKBXPwQKawwDYF9bPr"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "delete": {
        "tags": [
          "Reactor"
        ],
        "summary": "Delete Reactor logs",
        "description": "Delete the Reactor logs. To delete the Reactor logs of a specific log level you can use a `logLevel` filter.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Reactor logs were successfully deleted."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/projects/{projectId}/applications/{applicationId}/reactor/schedules/{scheduleId}": {
      "get": {
        "tags": [
          "Reactor"
        ],
        "summary": "Read a Reactor schedule",
        "description": "Read a single Reactor schedule by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          },
          {
            "$ref": "#/components/parameters/scheduleId"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of available Reactor schedules.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReactorScheduleDocument"
                },
                "example": {
                  "id": "UE9Bt3CyM4gd87g4rHYSBqTc",
                  "createdAt": 1475672402665,
                  "updatedAt": 1475672402665,
                  "event": {
                    "foo": "bar"
                  },
                  "function": "onScheduledEvent",
                  "cron": "0 45 14 * * ?",
                  "description": "Example Reactor schedule",
                  "enabled": true
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      },
      "put": {
        "tags": [
          "Reactor"
        ],
        "summary": "Update a Reactor schedule",
        "description": "Update fields of an existing Reactor schedule by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          },
          {
            "$ref": "#/components/parameters/scheduleId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Reactor schedule was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReactorScheduleDocument"
                },
                "example": {
                  "id": "UE9Bt3CyM4gd87g4rHYSBqTc",
                  "createdAt": 1475672402665,
                  "updatedAt": 1475674411237,
                  "event": {
                    "foo": "bar"
                  },
                  "function": "onScheduledEvent",
                  "cron": "0 45 14 * * ?",
                  "description": "Updated example Reactor schedule",
                  "enabled": false
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReactorScheduleDocument"
              },
              "example": {
                "description": "Updated Reactor schedule"
              }
            }
          },
          "description": "The request body for updating a Reactor schedule.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Reactor"
        ],
        "summary": "Delete a Reactor schedule",
        "description": "Delete a Reactor schedule by ID. A one-shot scheduled event (using `executeAt` instead of `cron`) will be deleted after it has elapsed, and not assigned an ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          },
          {
            "$ref": "#/components/parameters/scheduleId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Reactor schedule was deleted successfully"
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/projects/{projectId}/applications/{applicationId}/reactor/schedules": {
      "post": {
        "tags": [
          "Reactor"
        ],
        "summary": "Create a Reactor schedule",
        "description": "Create a Reactor schedule document, describing how the schedule should behave.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "201": {
            "description": "The Reactor schedule was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReactorScheduleDocument"
                },
                "example": {
                  "event": {
                    "foo": "bar"
                  },
                  "function": "onScheduledEvent",
                  "executeAt": 1475664300,
                  "description": "Example Reactor schedule",
                  "enabled": true
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReactorScheduleDocument"
              },
              "example": {
                "function": "onScheduledEvent",
                "event": {
                  "foo": "bar"
                },
                "executeAt": 1523028921000,
                "description": "Example Reactor schedule",
                "enabled": true
              }
            }
          },
          "description": "The request body for creating a Reactor schedule.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Reactor"
        ],
        "summary": "Read all Reactor schedules",
        "description": "Read all Reactor schedules of the specified application.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of all available Reactor schedules.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ReactorScheduleDocument"
                  }
                },
                "example": [
                  {
                    "id": "UE9Bt3CyM4gd87g4rHYSBqTc",
                    "createdAt": 1475672402665,
                    "updatedAt": 1475672402665,
                    "event": {
                      "foo": "bar"
                    },
                    "function": "onScheduledEvent",
                    "cron": "0 45 14 * * ?",
                    "description": "Example Reactor schedule",
                    "enabled": true
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/projects/{projectId}/applications/{applicationId}/reactor/script/status": {
      "get": {
        "tags": [
          "Reactor"
        ],
        "summary": "Read Reactor script status",
        "description": "Read the status of a Reactor script update in progress.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The status of the Reactor script.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReactorScriptStatusDocument"
                },
                "example": {
                  "updating": false
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/projects/{projectId}/applications/{applicationId}/reactor/script": {
      "put": {
        "tags": [
          "Reactor"
        ],
        "summary": "Update a Reactor script",
        "description": "Update the Reactor script for an application.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Reactor script was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReactorScriptDocument"
                },
                "example": {
                  "createdAt": 1491401875951,
                  "updatedAt": 1491401875951,
                  "type": "simple",
                  "script": "function onActionCreated(event) {\n  logger.info(JSON.stringify(event));\n  done();\n}"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReactorScriptDocument"
              },
              "example": {
                "script": "function onActionCreated(event) {\n  logger.info(JSON.stringify(event));\n  done();\n}"
              }
            }
          },
          "description": "The request body for updating a Reactor script.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Reactor"
        ],
        "summary": "Read a Reactor script",
        "description": "Read the Reactor script for an application by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Reactor script with associated metadata.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReactorScriptDocument"
                },
                "example": {
                  "createdAt": 1491401875951,
                  "updatedAt": 1491403179163,
                  "type": "simple",
                  "script": "function onActionCreated(event) {\n  logger.info(JSON.stringify(event));\n  done();\n}"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/projects/{projectId}/applications/{applicationId}/redirector": {
      "get": {
        "tags": [
          "Redirector"
        ],
        "summary": "Read an application Redirector",
        "description": "Read an application's Redirector.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Redirector was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationRedirectorRulesDocument"
                },
                "example": {
                  "id": "Ukr5GxCrEy2WNQPdEYkpmCrg",
                  "createdAt": 1490784605091,
                  "updatedAt": 1491209809028,
                  "rules": [
                    {
                      "match": "project.name=TestProduct",
                      "name": "TestAppRule",
                      "constants": {}
                    }
                  ]
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "Redirector"
        ],
        "summary": "Update an application Redirector",
        "description": "Update the application Redirector. Will be created if it does not exist.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The application Redirector was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationRedirectorRulesDocument"
                },
                "example": {
                  "id": "UfUtDs8d2ECpfpF6qFKKXg7d",
                  "createdAt": 1430220515122,
                  "updatedAt": 1430220515122,
                  "rules": [
                    {
                      "match": "thng.name=test",
                      "redirectUrl": "https://evrythng.com"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationRedirectorRulesDocument"
              },
              "example": {
                "rules": [
                  {
                    "match": "thng.name=test",
                    "redirectUrl": "https://evrythng.com"
                  }
                ]
              }
            }
          },
          "description": "The ApplicationRedirectorRulesDocument containing rules to create/update.",
          "required": true
        }
      }
    },
    "/projects/{projectId}/applications/{applicationId}/secretKey": {
      "get": {
        "tags": [
          "Applications"
        ],
        "summary": "Read Trusted App API Key",
        "description": "Read the Trusted Application API key for the application with `applicationId`. This is a secret key that has access to more endpoints than the standard Application API key.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Trusted Application API key.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SecretKeyDocument"
                },
                "example": {
                  "secretApiKey": "oEdxM3LcE351wLg1Zb2co6KmCLGIIUDmUNVKqbjb..."
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/projects/{projectId}/applications/{applicationId}": {
      "get": {
        "tags": [
          "Applications"
        ],
        "summary": "Read an application",
        "description": "Read an application by `applicationId` in the project specified by `projectId`.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The application requested, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationDocument"
                },
                "example": [
                  {
                    "appApiKey": "nbB8SdjtzWrgmbSQwp7HAHug3wCBPZ4MJwkqBvZL...",
                    "id": "Uh6GfhFnmgScpnxwMsqmbbBk",
                    "createdAt": 1472812938247,
                    "updatedAt": 1486632665680,
                    "name": "Main App",
                    "description": "Main app for API testing and documentation",
                    "project": "Uh5qRBqc4DcmbNbAANtMnrYm",
                    "socialNetworks": {},
                    "defaultRole": "base_app_user"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "Applications"
        ],
        "summary": "Update an application",
        "description": "Update an application by `applicationId`.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The updated application",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationDocument"
                },
                "example": {
                  "appApiKey": "nbB8SdjtzWrgmbSQwp7HAHug3wCBPZ4MJwkqBvZL...",
                  "id": "Uh6GfhFnmgScpnxwMsqmbbBk",
                  "createdAt": 1472812938247,
                  "updatedAt": 1486632665680,
                  "name": "Main App",
                  "description": "Main app for API testing and documentation",
                  "project": "Uh5qRBqc4DcmbNbAANtMnrYm",
                  "socialNetworks": {},
                  "defaultRole": "base_app_user"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationDocument"
              },
              "example": {
                "name": "Test Application",
                "description": "A test application",
                "socialNetworks": {}
              }
            }
          },
          "description": "The ApplicationDocument containing fields to create/update.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Applications"
        ],
        "summary": "Delete an application",
        "description": "Delete an application by `applicationId`.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/applicationId"
          }
        ],
        "responses": {
          "200": {
            "description": "The application was successfully deleted."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/projects/{projectId}/applications": {
      "post": {
        "tags": [
          "Applications"
        ],
        "summary": "Create an application",
        "description": "Create an application within a project. The object returned contains the `appApiKey` parameter, which is an Application API key that must be used within an external application to issue calls to the API. However, because this API key can be hard coded within external applications (e.g. mobile/JS) and is visible to anyone, it can be used only for a very limited set of operations (create users, read a product, send actions etc.).",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          }
        ],
        "responses": {
          "201": {
            "description": "The created application was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationDocument"
                },
                "example": {
                  "appApiKey": "nbB8SdjtzWrgmbSQwp7HAHug3wCBPZ4MJwkqBvZL...",
                  "id": "Uh6GfhFnmgScpnxwMsqmbbBk",
                  "createdAt": 1472812938247,
                  "updatedAt": 1486632665680,
                  "name": "Main App",
                  "description": "Main app for API testing and documentation",
                  "project": "Uh5qRBqc4DcmbNbAANtMnrYm",
                  "socialNetworks": {},
                  "defaultRole": "base_app_user"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationDocument"
              },
              "example": {
                "name": "Test Application",
                "description": "A test application",
                "socialNetworks": {}
              }
            }
          },
          "description": "The ApplicationDocument containing fields to create/update.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Applications"
        ],
        "summary": "Read all applications",
        "description": "Read all applications inside the specified project.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          }
        ],
        "responses": {
          "200": {
            "description": "All visible applications.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApplicationDocument"
                  }
                },
                "example": [
                  {
                    "appApiKey": "nbB8SdjtzWrgmbSQwp7HAHug3wCBPZ4MJwkqBvZL...",
                    "id": "Uh6GfhFnmgScpnxwMsqmbbBk",
                    "createdAt": 1472812938247,
                    "updatedAt": 1486632665680,
                    "name": "Main App",
                    "description": "Main app for API testing and documentation",
                    "project": "Uh5qRBqc4DcmbNbAANtMnrYm",
                    "socialNetworks": {},
                    "defaultRole": "base_app_user"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/projects/{projectId}": {
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Read a project",
        "description": "Read a project by ID",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested project, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectDocument"
                },
                "example": {
                  "id": "UFN3ahEYMGshYMaaaECtDeYd",
                  "createdAt": 1490618231682,
                  "updatedAt": 1490618231682,
                  "name": "Tagged Products",
                  "shortDomains": [
                    "tn.gg"
                  ]
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "Projects"
        ],
        "summary": "Update a project",
        "description": "Update a project by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          }
        ],
        "responses": {
          "200": {
            "description": "The updated project.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectDocument"
                },
                "example": {
                  "id": "UFN3ahEYMGshYMaaaECtDeYd",
                  "createdAt": 1490618231682,
                  "updatedAt": 1490618231682,
                  "name": "Tagged Products",
                  "shortDomains": [
                    "tn.gg"
                  ]
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProjectDocument"
              },
              "example": {
                "name": "Test Project"
              }
            }
          },
          "description": "The ProjectDocument containing fields to create/update.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Projects"
        ],
        "summary": "Delete a project",
        "description": "Delete a project by ID. This action **cannot** be reversed!",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          }
        ],
        "responses": {
          "200": {
            "description": "The project was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/projects": {
      "post": {
        "tags": [
          "Projects"
        ],
        "summary": "Create a project",
        "description": "Create a new project within an account.",
        "responses": {
          "201": {
            "description": "The project was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectDocument"
                },
                "example": {
                  "id": "UFN3ahEYMGshYMaaaECtDeYd",
                  "createdAt": 1490618231682,
                  "updatedAt": 1490618231682,
                  "name": "Tagged Products",
                  "shortDomains": [
                    "tn.gg"
                  ]
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProjectDocument"
              },
              "example": {
                "name": "Test Project"
              }
            }
          },
          "description": "The ProjectDocument containing fields to create/update.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Projects"
        ],
        "summary": "Read all projects",
        "description": "Read all projects.",
        "responses": {
          "200": {
            "description": "All projects in scope.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ProjectDocument"
                  }
                },
                "example": [
                  {
                    "id": "UkMptdx4eDsaQ5wRwDW3pmhn",
                    "createdAt": 1489761050680,
                    "updatedAt": 1489761050680,
                    "name": "Supply Chain PoC",
                    "shortDomains": [
                      "tn.gg"
                    ]
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/purchaseOrders/{purchaseOrderId}": {
      "get": {
        "summary": "Read a purchase order",
        "description": "Read a purchase order resource.",
        "tags": [
          "Purchase Orders"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/purchaseOrderId"
          }
        ],
        "responses": {
          "200": {
            "description": "The purchase order was found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PurchaseOrderDocument"
                },
                "example": {
                  "id": "1234567890",
                  "evrythngId": "UsStxg3pkgabqngdmrecpfeb",
                  "status": "open",
                  "type": "stand-alone",
                  "description": "A purchase order for 100 items",
                  "issueDate": "2019-02-14",
                  "parties": [
                    {
                      "id": "gs1:414:943234",
                      "type": "supplier"
                    },
                    {
                      "id": "gs1:414:01251",
                      "type": "ship-from"
                    },
                    {
                      "id": "gs1:414:NA0193",
                      "type": "ship-to"
                    }
                  ],
                  "lines": [
                    {
                      "id": "00010",
                      "quantity": 100,
                      "product": "gs1:01:00000123456789",
                      "exportDate": "2019-02-17",
                      "deliveryDate": "2019-02-20"
                    }
                  ],
                  "version": "1",
                  "createdAt": 1550143360591,
                  "updatedAt": 1550143360591
                }
              }
            }
          },
          "404": {
            "description": "The purchase order was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The requested resource was not found."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      },
      "put": {
        "summary": "Update a purchase order",
        "description": "Update a purchase order resource by ID.",
        "tags": [
          "Purchase Orders"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/purchaseOrderId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PurchaseOrderDocument"
              },
              "example": {
                "id": "234567890",
                "status": "open",
                "type": "stand-alone",
                "description": "A purchase order for 100 items",
                "issueDate": "2019-02-14",
                "parties": [
                  {
                    "id": "gs1:414:943234",
                    "type": "supplier"
                  },
                  {
                    "id": "gs1:414:01251",
                    "type": "ship-from"
                  },
                  {
                    "id": "gs1:414:NA0193",
                    "type": "ship-to"
                  }
                ],
                "lines": [
                  {
                    "id": "00010",
                    "quantity": 100,
                    "product": "gs1:01:00000123456789",
                    "exportDate": "2019-02-17",
                    "deliveryDate": "2019-02-20"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The Purchase Order was updated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PurchaseOrderDocument"
                },
                "example": {
                  "id": "1234567890",
                  "evrythngId": "UsStxg3pkgabqngdmrecpfeb",
                  "status": "open",
                  "type": "stand-alone",
                  "description": "A purchase order for 100 items",
                  "issueDate": "2019-02-14",
                  "parties": [
                    {
                      "id": "gs1:414:943234",
                      "type": "supplier"
                    },
                    {
                      "id": "gs1:414:01251",
                      "type": "ship-from"
                    },
                    {
                      "id": "gs1:414:NA0193",
                      "type": "ship-to"
                    }
                  ],
                  "lines": [
                    {
                      "id": "00010",
                      "quantity": 100,
                      "product": "gs1:01:00000123456789",
                      "exportDate": "2019-02-17",
                      "deliveryDate": "2019-02-20"
                    }
                  ],
                  "version": "1",
                  "createdAt": 1550143360591,
                  "updatedAt": 1550143456043
                }
              }
            }
          },
          "400": {
            "description": "Purchase order update payload did not validate.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "Purchase order id in request body does not match id in url."
                  ],
                  "code": 50593792,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50593792"
                }
              }
            }
          },
          "404": {
            "description": "The Purchase Order was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The requested resource was not found."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Delete a purchase order",
        "description": "Delete a purchase order resource by ID.",
        "tags": [
          "Purchase Orders"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/purchaseOrderId"
          }
        ],
        "responses": {
          "204": {
            "description": "The Purchase Order was deleted."
          },
          "404": {
            "description": "The Purchase Order was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The purchase order does not exist."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      }
    },
    "/purchaseOrders": {
      "post": {
        "summary": "Create a purchase order",
        "description": "Create a new purchase order resource.",
        "tags": [
          "Purchase Orders"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/useEvrythngId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PurchaseOrderDocument"
              },
              "example": {
                "id": "234567890",
                "status": "open",
                "type": "stand-alone",
                "description": "A purchase order for 100 items",
                "issueDate": "2019-02-14",
                "parties": [
                  {
                    "id": "gs1:414:943234",
                    "type": "supplier"
                  },
                  {
                    "id": "gs1:414:01251",
                    "type": "ship-from"
                  },
                  {
                    "id": "gs1:414:NA0193",
                    "type": "ship-to"
                  }
                ],
                "lines": [
                  {
                    "id": "00010",
                    "quantity": 100,
                    "product": "gs1:01:00000123456789",
                    "exportDate": "2019-02-17",
                    "deliveryDate": "2019-02-20"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The purchase order was successfully created.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PurchaseOrderDocument"
                },
                "example": {
                  "id": "234567890",
                  "evrythngId": "U8xtbEasDmbnhagkfsbgbpdr",
                  "status": "open",
                  "type": "stand-alone",
                  "description": "A purchase order for 100 items",
                  "issueDate": "2019-02-14",
                  "parties": [
                    {
                      "id": "gs1:414:943234",
                      "type": "supplier"
                    },
                    {
                      "id": "gs1:414:01251",
                      "type": "ship-from"
                    },
                    {
                      "id": "gs1:414:NA0193",
                      "type": "ship-to"
                    }
                  ],
                  "lines": [
                    {
                      "id": "00010",
                      "quantity": 100,
                      "product": "gs1:01:00000123456789",
                      "exportDate": "2019-02-17",
                      "deliveryDate": "2019-02-20"
                    }
                  ],
                  "version": "1",
                  "createdAt": 1550143360591,
                  "updatedAt": 1550143360591
                }
              }
            }
          },
          "400": {
            "description": "A purchase order was not created because the request was invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "PurchaseOrder should have required property 'type'"
                  ],
                  "code": 50331648,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50331648"
                }
              }
            }
          },
          "409": {
            "description": "A purchase order was not created because one with the same ID already exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 409,
                  "errors": [
                    "The purchase order already exists"
                  ],
                  "code": 67239936,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-67239936"
                }
              }
            }
          }
        }
      },
      "get": {
        "summary": "Read all purchase orders",
        "description": "List purchase orders in an account",
        "tags": [
          "Purchase Orders"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "responses": {
          "200": {
            "description": "A list of purchase orders",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PurchaseOrderDocument"
                  }
                },
                "example": [
                  {
                    "id": "234567890",
                    "evrythngId": "U8xtbEasDmbnhagkfsbgbpdr",
                    "status": "open",
                    "type": "stand-alone",
                    "description": "A purchase order for 100 items",
                    "issueDate": "2019-02-14",
                    "parties": [
                      {
                        "id": "gs1:414:943234",
                        "type": "supplier"
                      },
                      {
                        "id": "gs1:414:01251",
                        "type": "ship-from"
                      },
                      {
                        "id": "gs1:414:NA0193",
                        "type": "ship-to"
                      }
                    ],
                    "lines": [
                      {
                        "id": "00010",
                        "quantity": 100,
                        "product": "gs1:01:00000123456789",
                        "exportDate": "2019-02-17",
                        "deliveryDate": "2019-02-20"
                      }
                    ],
                    "version": "1",
                    "createdAt": 1550143360591,
                    "updatedAt": 1550143360591
                  },
                  {
                    "id": "234567891",
                    "evrythngId": "UsStxg3pkgabqngdmrecpfeb",
                    "status": "open",
                    "type": "stand-alone",
                    "description": "A purchase order for 10 items",
                    "issueDate": "2019-02-01",
                    "parties": [
                      {
                        "id": "gs1:414:92431223",
                        "type": "supplier"
                      },
                      {
                        "id": "gs1:414:9382392",
                        "type": "ship-from"
                      },
                      {
                        "id": "gs1:414:NA0193",
                        "type": "ship-to"
                      }
                    ],
                    "lines": [
                      {
                        "id": "00010",
                        "quantity": 10,
                        "product": "gs1:01:00000123456789",
                        "exportDate": "2019-02-10",
                        "deliveryDate": "2019-02-13"
                      }
                    ],
                    "createdAt": 1550143360594,
                    "updatedAt": 1550143360594
                  }
                ]
              }
            }
          }
        }
      }
    },
    "/rateLimits": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "summary": "View rate limit information",
        "description": "View rate limit information for the accounts.",
        "responses": {
          "200": {
            "description": "The available rate limit information",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RateLimitsDocument"
                  }
                },
                "example": [
                  {
                    "name": "trial",
                    "rateLimits": [
                      {
                        "url": {
                          "path": "/",
                          "depth": 1
                        },
                        "access": "crud",
                        "limit": {
                          "rate": "day",
                          "timeFrame": 1,
                          "warningMaxHits": 3600,
                          "blockingMaxHits": 5000
                        },
                        "hits": 3,
                        "hitsRemaining": 4997,
                        "reset": 30020
                      }
                    ]
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application",
          "Application User",
          "Device"
        ]
      }
    },
    "/redirections/{shortId}": {
      "get": {
        "tags": [
          "Redirections"
        ],
        "summary": "Read a redirection",
        "description": "Read a redirection.",
        "servers": [
          {
            "url": "https://tn.gg"
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/shortId"
          }
        ],
        "responses": {
          "200": {
            "description": "The redirection, if it exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RedirectionDocument"
                },
                "example": {
                  "createdAt": 1496664729327,
                  "updatedAt": 1496664729327,
                  "defaultRedirectUrl": "https://google.com",
                  "evrythngUrl": "https://api.evrythng.com/thngs/Uk6qwgSReXPat5awagfNpHsk",
                  "shortDomain": "tn.gg",
                  "shortId": "39aZNy4g",
                  "type": "thng",
                  "evrythngId": "UP73aanFqN6WnsAfF4fQ7a4e",
                  "hits": 0
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ]
      },
      "put": {
        "tags": [
          "Redirections"
        ],
        "summary": "Update a redirection",
        "description": "Update a redirection.",
        "servers": [
          {
            "url": "https://tn.gg"
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/shortId"
          }
        ],
        "responses": {
          "200": {
            "description": "The redirection was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RedirectionDocument"
                },
                "example": {
                  "createdAt": 1496668317836,
                  "updatedAt": 1496670833807,
                  "defaultRedirectUrl": "https://google.com/Uk6qwgSReXPat5awagfNpHsk",
                  "evrythngUrl": "https://api.evrythng.com/thngs/Uk6qwgSReXPat5awagfNpHsk",
                  "shortDomain": "tn.gg",
                  "shortId": "799yeEi4qp",
                  "type": "thng",
                  "evrythngId": "UP73aanFqN6WnsAfF4fQ7a4e",
                  "hits": 0
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RedirectionDocument"
              },
              "example": {
                "defaultRedirectUrl": "https://google.com/{shortId}"
              }
            }
          },
          "description": "The request body for creating a or updating a redirection.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Redirections"
        ],
        "summary": "Delete a redirection",
        "description": "Delete a redirection.",
        "servers": [
          {
            "url": "https://tn.gg"
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/shortId"
          }
        ],
        "responses": {
          "200": {
            "description": "The redirection was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/redirections": {
      "post": {
        "tags": [
          "Redirections"
        ],
        "summary": "Create a redirection",
        "description": "Create a Thng or product redirection.",
        "servers": [
          {
            "url": "https://tn.gg"
          }
        ],
        "responses": {
          "201": {
            "description": "The redirection was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RedirectionDocument"
                },
                "example": {
                  "createdAt": 1496668317836,
                  "updatedAt": 1496670833807,
                  "defaultRedirectUrl": "https://google.com/Uk6qwgSReXPat5awagfNpHsk",
                  "evrythngUrl": "https://api.evrythng.com/thngs/Uk6qwgSReXPat5awagfNpHsk",
                  "shortDomain": "tn.gg",
                  "shortId": "pk9a7qxA",
                  "type": "thng",
                  "evrythngId": "UP73aanFqN6WnsAfF4fQ7a4e",
                  "hits": 0
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RedirectionDocument"
              },
              "example": {
                "defaultRedirectUrl": "https://google.com/{shortId}",
                "evrythngId": "UP73aanFqN6WnsAfF4fQ7a4e",
                "type": "thng"
              }
            }
          },
          "description": "The request body for creating a redirection.",
          "required": true
        }
      }
    },
    "/redirector": {
      "get": {
        "tags": [
          "Redirector"
        ],
        "summary": "Read the account Redirector",
        "description": "Read the account-level Redirector.",
        "responses": {
          "200": {
            "description": "The account's Redirector, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountRedirectorRulesDocument"
                },
                "example": {
                  "id": "Uk7CRnXRwqWxeshgVgTq9n7g",
                  "createdAt": 1490356832220,
                  "updatedAt": 1491207910634,
                  "rules": [
                    {
                      "match": "thng.name=TestThng",
                      "name": "TestRule",
                      "redirectUrl": "https://google.com",
                      "delegates": [
                        {
                          "app": "Uk7KFKGKBXPwQKawwDYF9bPr",
                          "project": "UF7HfFU5q9QVEsRaaDAmbsEk"
                        }
                      ],
                      "constants": {
                        "test": "value"
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "Redirector"
        ],
        "summary": "Update the account Redirector",
        "description": "Update the account Redirector. Created if it does not exist.",
        "responses": {
          "200": {
            "description": "The account Redirector was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountRedirectorRulesDocument"
                },
                "example": {
                  "id": "Uk7CRnXRwqWxeshgVgTq9n7g",
                  "createdAt": 1490356832220,
                  "updatedAt": 1491208179520,
                  "rules": [
                    {
                      "match": "thng.name=test",
                      "delegates": [
                        {
                          "app": "Uk7KFKGKBXPwQKawwDYF9bPr",
                          "project": "UF7HfFU5q9QVEsRaaDAmbsEk"
                        }
                      ]
                    }
                  ]
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountRedirectorRulesDocument"
              },
              "example": {
                "rules": [
                  {
                    "match": "thng.name=test",
                    "delegates": [
                      {
                        "app": "Uk7KFKGKBXPwQKawwDYF9bPr",
                        "project": "UF7HfFU5q9QVEsRaaDAmbsEk"
                      }
                    ]
                  }
                ]
              }
            }
          },
          "description": "The AccountRedirectorRulesDocument to update.",
          "required": true
        }
      }
    },
    "/roles/{roleId}/permissions": {
      "get": {
        "tags": [
          "Role Permissions"
        ],
        "summary": "Read an Application User role's permissions",
        "description": "Read an array of paths and access types that an Application User with the specified role can access.",
        "parameters": [
          {
            "$ref": "#/components/parameters/roleId"
          }
        ],
        "responses": {
          "200": {
            "description": "The role's permitted paths and types of operations permitted.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserRolePermissionsDocument"
                },
                "example": [
                  {
                    "path": "/thngs",
                    "access": "cru"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "Role Permissions"
        ],
        "summary": "Update role permissions",
        "description": "Update the set of permissions for a role with a new set. The payload replaces the old set of permissions for this role. This must include any existing permissions, otherwise they will be deleted if not present in the new payload. To remove a permission, simply omit it in the payload after reading from the role initially.",
        "parameters": [
          {
            "$ref": "#/components/parameters/roleId"
          }
        ],
        "responses": {
          "200": {
            "description": "The permissions were set successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserRolePermissionsDocument"
                },
                "example": [
                  {
                    "path": "/thngs",
                    "access": "cru"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationUserRolePermissionsDocument"
              },
              "example": [
                {
                  "path": "/thngs",
                  "access": "cru"
                }
              ]
            }
          },
          "description": "The ApplicationUserRolePermissionDocument to set new permissions.",
          "required": true
        }
      }
    },
    "/roles/{roleId}": {
      "get": {
        "tags": [
          "Roles"
        ],
        "summary": "Read a role",
        "description": "Read a single role by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/roleId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested role, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserRoleDocument"
                },
                "example": {
                  "id": "58f8773ffc7c042800fda32b",
                  "version": 2,
                  "type": "userInApp",
                  "name": "Test Role",
                  "description": "A role for the purposes of testing.",
                  "customFields": {
                    "test": true
                  },
                  "createdAt": 1492678463423,
                  "updatedAt": 1492678463423
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      },
      "put": {
        "tags": [
          "Roles"
        ],
        "summary": "Update a role",
        "description": "Update a role by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/roleId"
          }
        ],
        "responses": {
          "200": {
            "description": "The role was updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserRoleDocument"
                },
                "example": {
                  "id": "58f8773ffc7c042800fda32b",
                  "version": 2,
                  "type": "userInApp",
                  "name": "Test Role",
                  "description": "A role for the purposes of testing.",
                  "customFields": {
                    "test": true
                  },
                  "createdAt": 1492678463423,
                  "updatedAt": 1492678725176
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationUserRoleDocument"
              },
              "example": {
                "name": "Updated Engineer Role",
                "description": "Engineer authorized to perform device repairs"
              }
            }
          },
          "description": "The request body for updating a role.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Roles"
        ],
        "summary": "Delete a role",
        "description": "Delete a role by ID. The predefined `none` role will be assigned to all the users currently having the role about to be removed. A `userInApp` role cannot be deleted until all users with that role have been assigned a different role.",
        "parameters": [
          {
            "$ref": "#/components/parameters/roleId"
          }
        ],
        "responses": {
          "200": {
            "description": "The role was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/roles": {
      "post": {
        "tags": [
          "Roles"
        ],
        "summary": "Create an Application User role",
        "description": "Create a new Application User role. Only the account owner can create new roles. You cannot create roles with the same `name` as the predefined `admin` and `none` roles. Roles `name`s are considered unique. This means two roles with different `id`s cannot share the same `name`.",
        "responses": {
          "201": {
            "description": "The new role was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserRoleDocument"
                },
                "example": {
                  "id": "58f8773ffc7c042800fda32b",
                  "version": 2,
                  "type": "userInApp",
                  "name": "Test Role",
                  "description": "A role for the purposes of testing.",
                  "customFields": {
                    "test": true
                  },
                  "createdAt": 1492678463423,
                  "updatedAt": 1492678463423
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationUserRoleDocument"
              },
              "example": {
                "name": "Test Role",
                "version": 2,
                "type": "userInApp",
                "description": "A role for the purposes of testing.",
                "customFields": {
                  "test": true
                }
              }
            }
          },
          "description": "The request body for creating a role.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Roles"
        ],
        "summary": "Read all roles",
        "description": "Read all available roles within the account.",
        "responses": {
          "200": {
            "description": "An array of the available roles.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApplicationUserRoleDocument"
                  }
                },
                "example": [
                  {
                    "id": "admin",
                    "name": "admin"
                  },
                  {
                    "id": "none",
                    "name": "none"
                  },
                  {
                    "id": "base_app_user",
                    "version": 2,
                    "type": "userInApp",
                    "name": "base_app_user"
                  },
                  {
                    "id": "58f8773ffc7c042800fda32b",
                    "version": 2,
                    "type": "userInApp",
                    "name": "Test Role",
                    "description": "A role for the purposes of testing.",
                    "customFields": {
                      "test": true
                    },
                    "createdAt": 1492678463423,
                    "updatedAt": 1492678463423
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User"
        ]
      }
    },
    "/scan/identifications": {
      "post": {
        "tags": [
          "Identifier Recognition"
        ],
        "summary": "Identify from an image",
        "description": "Identify a 1D or 2D barcode from an uploaded image.",
        "parameters": [
          {
            "$ref": "#/components/parameters/scanFilter"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was accepted, and results may be returned.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ScanImageResultsDocument"
                  }
                },
                "example": [
                  {
                    "results": [
                      {
                        "redirections": [
                          "https://tn.gg/yyZZ1nAh"
                        ],
                        "product": {
                          "id": "UYKNDMGcswyFBdf6wr7M5Erm",
                          "properties": {},
                          "name": "Box of Cereals",
                          "identifiers": {}
                        }
                      }
                    ],
                    "meta": {
                      "method": "2d",
                      "score": 100,
                      "value": "https://tn.gg/yyZZ1nAh",
                      "type": "qr_code"
                    }
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Trusted Application",
          "Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ScanImageContentDocument"
              },
              "example": {
                "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH4QcEDTEFkmFJrgAACtVJREFUeNrtXc9u2k4QHhLUUNE3gAP3mlJRqtJAlRw59BnCIa54gR5AQgoSleihLxCVHHiISjmmUoKIRBPSuHcO7hsQkUY0/A79Ye1OzK6XtfkT5pMshRh718vAfDs732xoPB6PgbC22KAhIAMgkAEQyAAIZAAEMgACGQCBDIBABkAgAyCQARDIAAhkAAQyAMIjRVjn4pOTE/j+/ftcOrqzswO7u7u+3a9SqUAkEgEAgNvbW2g0GlPfa9s2HB4eQjgc9tS3o6MjsG17NcZlrIFarTYGgLkctVpt7Cfw/UXodDpKfctmsyszLuQCiAMQdDEajdaTA2A0m00wDMOXe1mWBaZpTj1/dHQEzWbT9dzd3R20Wi2uL8lkEp49ewYAAMPhEHq9Htze3gIAQCQSgZcvX8LTp08BAMAwDPj69evUtk3T5PoWi8XmNi7NZnPqcy/cAAzDgDdv3szFcm3bhk6nM/X8zc3NA4NikUqluNdXV1ee247H40rP6ee4HB8fkwsgkAFI/e6TJ09mvvfd3Z3w/ObmJsUBvODDhw8PfnpFP5Miv4tRKpXg/fv3zoe9t7fHtbW3t+f4fLf5+7t37xwjwpwgGo0K2z48PIRv375xnGB/f99z31k+4ve4LJUBWJYl9NM6iMfjEI/Hndd4QGWGd3p6KuQEMv7BBnoKhYLyuJALIJABLBKhUMjzeychYzKAFYJlWTAej4XHNJydnUEoFHKOYrHIXSdaNyADWBIMBoPZiREijZMA0QR//vwhAyCQASzXfBZ9a/GsQEUELZuiTaaL016TAcwBlUqF89N4WmcYBneeJX1ufIB9nyxu32g0Hg0nWFkD0GHmKjMAcgGER41AI4EqS6Cqy6XxeByy2ay7VW9swM+fP5VmAoZhOL5/MBhw0brBYACXl5fOGkEsFuOikLOMi0ooeGUNIMgY9v7+vjD+nsvloN1ue77f9fW18/fl5SWk02kupsC+rlarUK/XZ+472xa5gIBwf38/87Wy1cBpyaHEAQjrzQH8XOWS3cu2bfj9+7fzbVdZYgX4F+6dfJNHoxHkcjlhXODFixfcr8r5+bnzt4wT+Dkuvqebr2paeLVa5c63221harZKWjhOA9/e3ubOHxwccOer1Sqlhc/9pwv54Y2N4B4F8wkcR1hlTkAcYM0R0qkUukhpGNv2JJTLuDXutZv0i5WGTXGNzj3i8Tg35cTPvbbSsGUC9rudTmdmqVg2mx2vC8gFrDnIACgOMDtYXzgajaBUKnHzYdYXyvww9rNYki3zdaZpOtm5o9HogVxL5vNrtZrzN57Tq/ZFBh1put8yeV/jANjvqszFsd/Fc3Hd+a5sPq0iD/e7L/NsmzgAwT8OgOVZOgsw+F44uLJMEux5SsPwmPq9v4cWB2DlWZN4vAgiOVa/34fXr187H3wikYBut+u8H/t0Vh7uJgdnZWleInVs32RyLCwNUwF+bplhJ5NJaLfbTqTz+PgY3r59y3EfFVnaXOMAspi4yNfJ5uKq/EPlkPER3cNP3kUlYgjLGwdQWaBR9fnYF/rJGWR85DHxD1+fjPW7k7w8r34X+3zMCTAKhYKjPA6Hw/Dlyxfo9/vOB/jx40dIJBIA8G89X5ZbZ1mWk0Mo4yMYuGyLqCSMzDAty4JisTi1voHfawy+J4SoyMFxLv+rV6+4191ud+q1hUKBK7vS7/e5thOJhFJZlufPnwvbxn1jgcu26JSEubm5gYuLCwoFE1bQAIbDoef34qQKfK1M+LG1tTWzn5YJQ3BqmSoHEKWmuc3j2f+pchdtWZrOFKJcLnNTkl6vx53P5/Oep0O9Xo87l0qluPONRkNpqoWnhbKpmMq9y+WyUmrc6enpzKFgy7K49zYajeUJBeNvKbZGFWvG1y6zJFtVlqYzi8DiFr/HgTgAcYDZgb+1+JuB/brI98quxT5fxw+vMlTHIVAOgJFKpYScgD0XCoWEPh9zAnxgXyjjG2x7uG38v3w+L/TDOPwq4wAsH7m/vxfyD8MwlMLQmI8sNBSM/baIoWI2rHKtmy9UiRyqMnGdcjO6MxC/+QhxAMJqGMA81//xtxJ/42V98d0vz3EcltYAcrnc3Mqw4HIxWL6N+zIxmslRqVRWdhxWxgU8ptJsyzQOxAHWHFqrgaxEOxwOO8uvAP/StGRVt/P5PLcc/OPHj6k+T7YMKlruDYfDD1YeRRgMBnB9fe3kM0SjUe7+uDwNLh4tAytNj0QikEqlnFmQ7jjMNQ6AJdrdbnfmdOhutxuoLBoU0rTa7TZ3Lp1OC+9dr9d9W5cIehx8jQMEmYWz0KkRymSSbT7x9+/flZz9EAcg6HEA1heORiMnJQvAvWwLLsXGIhqNQjqd9rzVi6xMm2VZzsZR2M+6cYJfv35xKWGZTIZLCWP9Mi4Jw46DlxJ17DgMh0O4urri0uPZtnHJOrxRhk65Om0OgJHJZIRlW+aJdDo98/p/JpMR+mVcEgZje3tbSaouavvi4oI7X6/Xl1caNs+yLTLobBol4zay9X0dhRS+Ny5Z5yffIA5A8E8ePh6PoVAoeJZoY1m0bIduFWxubj6YL3/+/JmLorFycDfUajVnjQDf6+TkRKntZrM5dcNH2TpCLBaDarXKycOXJg4gk2fplGYL+tDZLTzIY97lacgFrDnIAIgDzI6dnR3Hl7r5fIxyucxxAJGv88I/RL7YNE1njry1taW0ZCvrC257d3fXc9kWWV9s24ZPnz55ZvtrWyZOJQ9PNRc/aIk2UKlYAnEATcgWTYKUdNPu4f+DLdMSNHApFLY8jduHz8rFvZRlYdctcIkYLNmWrcmzMnm38jUYrDTd7ZxpmstpALZtB7Y7OAbeoRsvimBgubhsd3BRTX9VyTaWyU8WpaYBS9PJBRDIALQfTGMhCi/AqC7u6F6vcq1uAomvTElUGkUVqr5PVp6GLUczyfljcXp66hBHnMuIS7XhkjAYrVbL+dlXLZ+H+Qdu2y1msTQGoFMaxQ+DEfERWVKobM8gtjbftIUddhxUIOobbptcAIEMwA2i8jRe9grWKcGqIw2TydJW2gCSyeSDHbynHTI/iYF3D2+1WpyEKp/Pcx+uaLdwvLu4KnBfvBzT+oa5ydnZmfA+urK0QA1AReqsK4vWKU8zb6j82sgimiQPJ6ynAaiWp1kmqLgb2Tdct0zcyhpAo9HgfGexWBRyApEf1uUjuC9ejmnAPr9YLArvoysXfzQuQLXEjKhkjCof8VOyjX0+fi5yAQRfsbKb3upK0zFUpOoAwMnDVWRqbr8uIlkajiqyzw0g37ncy5RkbruGgcYuHbLdw1Wl6aAh0T44ONCSqYGCLE0myZfJ1NZm93A/5/2ye6kGjVRkarJ5Pz6vm/lEHIA4QHBQWRVTXUFjJdlefD4ryZbJw0XZQRM/fH5+7tkPs8+mW65GlX8slAPoIOgdM8HH1GxVP6zChXC5GlX+QWnhC+Ajvs7TUSKIzqIVcQBCsBxAJIOeZZ4vgsrO5W4QycNt2+ZSvuLxOJRKJUeuhaVh7N9e+iJqW+bTsRxuodIwmTwLApRA6cYgVPgH9suqsjTZLuo6UnWShhGIAxAWxAFYeXjQwKVRZNJ00zQfqIkmkK0UYnk49sui55b1RXX9XiZV1y0ZExr7vSE9gVwAgQyAQAZAIAMgkAEQyAAIZAAEMgACGQCBDIBABkAgAyCQARDIAAhLgP8AWkJ7J8JKts0AAAAASUVORK5CYII="
              }
            }
          },
          "description": "The request body for uploading an image in Base 64 encoding format.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Identifier Recognition"
        ],
        "summary": "Read an identifier",
        "description": "Read a known identifier for its resource.",
        "parameters": [
          {
            "$ref": "#/components/parameters/filter"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was accepted, and results may be returned.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ScanImageResultsDocument"
                  }
                },
                "example": [
                  {
                    "results": [
                      {
                        "redirections": [
                          "https://tn.gg/Q9Wqcg4w"
                        ],
                        "product": {
                          "id": "UYKNDMGcswyFBdf6wr7M5Erm",
                          "properties": {},
                          "name": "Box of Cereals",
                          "identifiers": {}
                        }
                      }
                    ],
                    "meta": {
                      "method": "2d",
                      "score": 100,
                      "value": "https://tn.gg/Q9Wqcg4w",
                      "type": "qr_code"
                    }
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Trusted Application",
          "Application"
        ]
      }
    },
    "/shipmentNotices/{shipmentNoticeId}": {
      "get": {
        "x-api-status": "Beta",
        "summary": "Read a shipment notice",
        "description": "Read a shipment notice resource.",
        "tags": [
          "Shipment Notices"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/shipmentNoticeId"
          }
        ],
        "responses": {
          "200": {
            "description": "The shipment notice was found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentNoticeDocument"
                },
                "example": {
                  "id": "Un9MbDrTBXsatpawwkbDRHdb",
                  "asnId": "9827429837429823828273",
                  "version": "1",
                  "purchaseOrderId": "4700990774",
                  "issueDate": "2019-06-19T16:39:57-08:00",
                  "transportation": "Expedited Freight",
                  "parties": [
                    {
                      "id": "gs1:414:01251",
                      "type": "ship-from"
                    },
                    {
                      "name": "The Landmark, Shop No. G14",
                      "type": "ship-to",
                      "address": {
                        "street": "113-114, Central",
                        "city": "Hong Kong"
                      }
                    }
                  ],
                  "tags": [
                    "ongoing",
                    "important",
                    "access-all"
                  ],
                  "createdAt": 1550143360591,
                  "updatedAt": 1550143360591
                }
              }
            }
          },
          "404": {
            "description": "The shipment notice was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The requested resource was not found."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      },
      "put": {
        "x-api-status": "Beta",
        "summary": "Update a shipment notice",
        "description": "Update a shipment notice resource.",
        "tags": [
          "Shipment Notices"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/shipmentNoticeId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentNoticeDocument"
              },
              "example": {
                "asnId": "9827429837429823828273",
                "version": "2",
                "purchaseOrderId": "4700990774",
                "issueDate": "2019-06-19T16:39:57-08:00",
                "transportation": "Expedited Freight",
                "parties": [
                  {
                    "id": "gs1:414:01251",
                    "type": "ship-from"
                  },
                  {
                    "name": "The Landmark, Shop No. G14",
                    "type": "ship-to",
                    "address": {
                      "street": "113-114, Central",
                      "city": "Hong Kong"
                    }
                  }
                ],
                "tags": [
                  "ongoing",
                  "important",
                  "access-all"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The shipment notice was updated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentNoticeDocument"
                },
                "example": {
                  "id": "Un9MbDrTBXsatpawwkbDRHdb",
                  "asnId": "9827429837429823828273",
                  "version": "2",
                  "purchaseOrderId": "4700990774",
                  "issueDate": "2019-06-19T16:39:57-08:00",
                  "transportation": "Expedited Freight",
                  "parties": [
                    {
                      "id": "gs1:414:01251",
                      "type": "ship-from"
                    },
                    {
                      "name": "The Landmark, Shop No. G14",
                      "type": "ship-to",
                      "address": {
                        "street": "113-114, Central",
                        "city": "Hong Kong"
                      }
                    }
                  ],
                  "tags": [
                    "ongoing",
                    "important",
                    "access-all"
                  ],
                  "createdAt": 1550143360591,
                  "updatedAt": 1550143860591
                }
              }
            }
          },
          "400": {
            "description": "Shipment notice update payload did not validate.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "Shipment notice should have at least two parties."
                  ],
                  "code": 50593792,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50593792"
                }
              }
            }
          },
          "404": {
            "description": "The shipment notice was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 404,
                  "errors": [
                    "The requested resource was not found."
                  ],
                  "code": 16842752,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-16842752"
                }
              }
            }
          }
        }
      },
      "delete": {
        "x-api-status": "Beta",
        "summary": "Delete a shipment notice",
        "description": "Delete a shipment notice resource.",
        "tags": [
          "Shipment Notices"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/shipmentNoticeId"
          }
        ],
        "responses": {
          "204": {
            "description": "The shipment notice was deleted."
          }
        }
      }
    },
    "/shipmentNotices": {
      "post": {
        "x-api-status": "Beta",
        "summary": "Create a shipment notice",
        "description": "Create a new shipment notice resource.",
        "tags": [
          "Shipment Notices"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/useEvrythngId"
          }
        ],
        "x-api-keys": [
          "Operator"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentNoticeDocument"
              },
              "example": {
                "asnId": "9827429837429823828273",
                "version": "1",
                "purchaseOrderId": "4700990774",
                "issueDate": "2019-06-19T16:39:57-08:00",
                "transportation": "Expedited Freight",
                "parties": [
                  {
                    "id": "gs1:414:01251",
                    "type": "ship-from"
                  },
                  {
                    "name": "The Landmark, Shop No. G14",
                    "type": "ship-to",
                    "address": {
                      "street": "113-114, Central",
                      "city": "Hong Kong"
                    }
                  }
                ],
                "contents": [
                  {
                    "product": "gs1:01:00001254563898",
                    "quantity": 250
                  },
                  {
                    "product": "gs1:01:00283679123844",
                    "quantity": 42
                  }
                ],
                "tags": [
                  "ongoing",
                  "important",
                  "access-all"
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The shipment notice was successfully created.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentNoticeDocument"
                },
                "example": {
                  "id": "Un9MbDrTBXsatpawwkbDRHdb",
                  "asnId": "9827429837429823828273",
                  "version": "1",
                  "purchaseOrderId": "4700990774",
                  "issueDate": "2019-06-19T16:39:57-08:00",
                  "transportation": "Expedited Freight",
                  "parties": [
                    {
                      "id": "gs1:414:01251",
                      "type": "ship-from"
                    },
                    {
                      "name": "The Landmark, Shop No. G14",
                      "type": "ship-to",
                      "address": {
                        "street": "113-114, Central",
                        "city": "Hong Kong"
                      }
                    }
                  ],
                  "contents": [
                    {
                      "product": "gs1:01:00001254563898",
                      "quantity": 250
                    },
                    {
                      "product": "gs1:01:00283679123844",
                      "quantity": 42
                    }
                  ],
                  "tags": [
                    "ongoing",
                    "important",
                    "access-all"
                  ],
                  "createdAt": 1550143360591,
                  "updatedAt": 1550143360591
                }
              }
            }
          },
          "400": {
            "description": "A shipment notice was not created because the request was invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 400,
                  "errors": [
                    "Shipment notice should have required property 'id'"
                  ],
                  "code": 50331648,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-50331648"
                }
              }
            }
          },
          "409": {
            "description": "A shipment notice was not created because one with the same ID already exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                },
                "example": {
                  "status": 409,
                  "errors": [
                    "The shipment notice already exists"
                  ],
                  "code": 67239936,
                  "moreInfo": "https://developers.evrythng.com/docs/http-verbs-errors#client-errors-67239936"
                }
              }
            }
          }
        }
      },
      "get": {
        "x-api-status": "Beta",
        "summary": "Read all shipment notices",
        "description": "Read all shipment notices in an account",
        "tags": [
          "Shipment Notices"
        ],
        "x-api-keys": [
          "Operator"
        ],
        "x-filterable-fields": [
          "tags",
          "status",
          "purchaseOrderId"
        ],
        "responses": {
          "200": {
            "description": "A list of shipment notices was returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "description": "List of shipment notices returned",
                  "items": {
                    "$ref": "#/components/schemas/ShipmentNoticeDocument"
                  }
                },
                "example": [
                  {
                    "asnId": "9827429837429823828273",
                    "id": "Un9MbDrTBXsatpawwkbDRHdb",
                    "version": "1",
                    "purchaseOrderId": "4700990774",
                    "issueDate": "2019-06-19T16:39:57-08:00",
                    "transportation": "Expedited Freight",
                    "parties": [
                      {
                        "id": "gs1:414:01251",
                        "type": "ship-from"
                      },
                      {
                        "name": "The Landmark, Shop No. G14",
                        "type": "ship-to",
                        "address": {
                          "street": "113-114, Central",
                          "city": "Hong Kong"
                        }
                      }
                    ],
                    "tags": [
                      "ongoing",
                      "important",
                      "access-all"
                    ],
                    "createdAt": 1550143360591,
                    "updatedAt": 1550143360591
                  },
                  {
                    "asnId": "ASN:39842734:FASSLK",
                    "id": "UrVeSHdrBD8a9pwwRpHVAnYf",
                    "version": "12",
                    "purchaseOrderId": "5230917486",
                    "issueDate": "2018-05-13T12:00:00-03:00",
                    "transportation": "Truckload",
                    "createdAt": 1550143360591,
                    "updatedAt": 1550143360591,
                    "parties": [
                      {
                        "id": "factory:23048273",
                        "type": "ship-from"
                      },
                      {
                        "name": "GREOLE HUB",
                        "type": "ship-to",
                        "address": {
                          "country": "CN",
                          "latitude": 43.493847983,
                          "longitude": 56.342948273
                        }
                      },
                      {
                        "name": "GREOLE TRST. Co.",
                        "type": "bill-to",
                        "address": {
                          "country": "CN",
                          "latitude": 43.837298364,
                          "longitude": 56.4998243
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    },
    "/thngs/{thngIdentifier}/actions/commissions": {
      "post": {
        "tags": [
          "Commissioning"
        ],
        "summary": "Commission a Thng",
        "description": "Assign a product to a Thng and create and action of type commissions.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngIdentifier"
          }
        ],
        "requestBody": {
          "description": "Details of the commissioning action.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CommissionDocument"
              },
              "example": {
                "product": "gs1:01:05000157089908",
                "purchaseOrder": "2300003783",
                "occurredAt": "2019-01-25T09:19:00Z",
                "factoryMetadata": {
                  "factory": "gs1:414:87923487"
                },
                "location": {
                  "position": {
                    "type": "Point",
                    "coordinates": [
                      -0.08005,
                      51.527668
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The commissions action was successfully created.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "id": "UqV4N2FwpQWbRUwwRmkRwxfm",
                  "createdAt": 1548408960778,
                  "customFields": {
                    "purchaseOrder": "2300003783",
                    "factory": "gs1:414:87923487"
                  },
                  "timestamp": 1548408960778,
                  "type": "commissions",
                  "location": {
                    "latitude": 51.527668,
                    "longitude": -0.08005,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        -0.08005,
                        51.527668
                      ]
                    }
                  },
                  "locationSource": "unknown",
                  "context": {
                    "ipAddress": "141.0.154.202",
                    "city": "City of London",
                    "region": "England",
                    "countryCode": "GB",
                    "userAgent": "ReactorNetty/0.8.4.RELEASE",
                    "timeZone": "Europe/London"
                  },
                  "thng": "UMen7ds4s6HKsBRRarB4FArq",
                  "product": "U5sHN4k8CynCtcwRwGTXGsVp"
                }
              }
            }
          },
          "400": {
            "description": "One of dependent resources (product, Factory place or Purchase Order) was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                }
              }
            }
          },
          "404": {
            "description": "The target Thng was not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                }
              }
            }
          },
          "409": {
            "description": "Thng has not been encoded yet or has already been commissioned\nThe Factory is not specified while the Thng requires it\nThe Factory is specified but differs with the Factory of the Thng\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/thngs/{thngIdentifier}/actions/decommissions": {
      "post": {
        "tags": [
          "Commissioning"
        ],
        "summary": "Decommission a Thng",
        "description": "Removes the product assignment from a Thng and creates an action of type decommissions.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngIdentifier"
          }
        ],
        "requestBody": {
          "description": "Details of the decommission event.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DecommissionDocument"
              },
              "example": {
                "occurredAt": "2019-01-26T09:19:00Z",
                "factoryMetadata": {
                  "factory": "gs1:414:87923487"
                },
                "location": {
                  "position": {
                    "type": "Point",
                    "coordinates": [
                      -0.08005,
                      51.527668
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Decommission was successful",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "id": "UMBnPhMes6n5PewRa7frwqXn",
                  "createdAt": 1548412868140,
                  "timestamp": 1548412868140,
                  "type": "decommissions",
                  "customFields": {
                    "factory": "gs1:414:87923487"
                  },
                  "location": {
                    "latitude": 51.527668,
                    "longitude": -0.08005,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        -0.08005,
                        51.527668
                      ]
                    }
                  },
                  "locationSource": "unknown",
                  "context": {
                    "ipAddress": "141.0.154.202",
                    "city": "City of London",
                    "region": "England",
                    "countryCode": "GB",
                    "userAgent": "ReactorNetty/0.8.4.RELEASE",
                    "timeZone": "Europe/London"
                  },
                  "thng": "UMen7ds4s6HKsBRRarB4FArq"
                }
              }
            }
          },
          "400": {
            "description": "One of the dependent resources (Place, Factory) was not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                }
              }
            }
          },
          "404": {
            "description": "The target Thng was not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                }
              }
            }
          },
          "409": {
            "description": "The Thng has already been decommissioned or has never been commissioned\nThe Factory is not specified while the Thng requires it\nThe Factory is specified but differs with the Factory of the Thng\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/thngs/{thngIdentifier}/commissionState": {
      "get": {
        "tags": [
          "Commissioning"
        ],
        "summary": "Read Thng commissioning state",
        "description": "Returns the commissioning state of a Thng",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngIdentifier"
          }
        ],
        "responses": {
          "200": {
            "description": "Commissioning state of the Thng was successfully returned",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StateDocument"
                },
                "example": {
                  "state": "commissioned"
                }
              }
            }
          },
          "400": {
            "description": "Invalid filter value",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                }
              }
            }
          },
          "409": {
            "description": "More than one Thng was found for the specified identifier.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                }
              }
            }
          },
          "500": {
            "description": "Failed to get state of the Thng",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDocument"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/thngs/{thngId}/actions/{actionType}/{actionId}": {
      "get": {
        "tags": [
          "Thngs"
        ],
        "summary": "Read a Thng action",
        "description": "Read an action on a Thng by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          },
          {
            "$ref": "#/components/parameters/actionType"
          },
          {
            "$ref": "#/components/parameters/actionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested action, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "id": "UF8gd9hD6ttBE8awRgNUmafh",
                  "createdAt": 1491484534118,
                  "timestamp": 1491484534118,
                  "type": "_permanent",
                  "location": {
                    "latitude": 51.4519,
                    "longitude": 0.1792,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        0.1792,
                        51.4519
                      ]
                    }
                  },
                  "locationSource": "geoIp",
                  "thng": "UFNPxXxwVDPRQpaRwYPttarb"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ]
      }
    },
    "/thngs/{thngId}/actions/{actionType}": {
      "post": {
        "tags": [
          "Thngs"
        ],
        "summary": "Create a Thng action",
        "description": "Create an action on a Thng.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          },
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "201": {
            "description": "The action was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionDocument"
                },
                "example": {
                  "id": "UkPgUBmABXPwQpaawhKtSCms",
                  "createdAt": 1491481747604,
                  "timestamp": 1491481747604,
                  "type": "_permanent",
                  "location": {
                    "latitude": 51.4519,
                    "longitude": 0.1792,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        0.1792,
                        51.4519
                      ]
                    }
                  },
                  "locationSource": "geoIp",
                  "context": {
                    "ipAddress": "141.0.154.202",
                    "city": "Crayford",
                    "region": "England",
                    "countryCode": "GB",
                    "userAgent": "Mozilla/5.0 (X11; CrOS x86_64 8172.45.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.64 Safari/537.36",
                    "operatingSystemName": "Unknown",
                    "timeZone": "Europe/London"
                  },
                  "thng": "UFNPxXxwVDPRQpaRwYPttarb"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ActionDocument"
              },
              "example": {
                "type": "scans"
              }
            }
          },
          "description": "The request body to create an action, which does not include the resource.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Thngs"
        ],
        "summary": "Read all Thng actions",
        "description": "Read all actions on a Thng.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          },
          {
            "$ref": "#/components/parameters/actionType"
          }
        ],
        "responses": {
          "200": {
            "description": "Array of all available actions on this thng.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ActionDocument"
                  }
                },
                "example": [
                  {
                    "id": "UF8gd9hD6ttBE8awRgNUmafh",
                    "createdAt": 1491484534118,
                    "timestamp": 1491484534118,
                    "type": "_permanent",
                    "location": {
                      "latitude": 51.4519,
                      "longitude": 0.1792,
                      "position": {
                        "type": "Point",
                        "coordinates": [
                          0.1792,
                          51.4519
                        ]
                      }
                    },
                    "locationSource": "geoIp",
                    "thng": "UFNPxXxwVDPRQpaRwYPttarb"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ]
      }
    },
    "/thngs/{thngId}/location": {
      "get": {
        "tags": [
          "Thngs"
        ],
        "summary": "Read a Thng's location",
        "description": "Read a Thng's location history.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Thng's location history.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/LocationDocument"
                  }
                },
                "example": [
                  {
                    "createdAt": 1490878669475,
                    "timestamp": 1490878669475,
                    "latitude": 36,
                    "longitude": -17.3,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        -17.3,
                        36
                      ]
                    }
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ]
      },
      "put": {
        "tags": [
          "Thngs"
        ],
        "summary": "Update a Thng's location",
        "description": "Update a Thng's location. The payload must always be an array of `LocationDocument` objects, which allows you to send several locations (with different timestamps each) in a single request. This is useful when a device wants to update a path cached over a certain period of time at once. An example would be a taxi that updates the whole set of locations it has been through once per hour instead of sending each GPS sensor reading individually.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Thng's location was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/LocationDocument"
                  }
                },
                "example": [
                  {
                    "timestamp": 1490880049611,
                    "latitude": 36,
                    "longitude": -17.3,
                    "position": {
                      "type": "Point",
                      "coordinates": [
                        -17.3,
                        36
                      ]
                    }
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/LocationDocument"
                }
              },
              "example": [
                {
                  "position": {
                    "type": "Point",
                    "coordinates": [
                      -17.3,
                      36
                    ]
                  }
                },
                {
                  "timestamp": 1347028945711,
                  "position": {
                    "type": "Point",
                    "coordinates": [
                      -179.3,
                      -37
                    ]
                  }
                }
              ]
            }
          },
          "description": "The LocationDocument to update the Thng's location.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Thngs"
        ],
        "summary": "Delete a Thng location history",
        "description": "Delete a Thng's location history. If the `?to=Timestamp` query parameter with timestamp is not specified, all history for this property will be deleted.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The location history was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/thngs/{thngId}/properties/{propertyKey}": {
      "put": {
        "tags": [
          "Properties"
        ],
        "summary": "Update a Thng property",
        "description": "Update a single Thng property by `key`.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          },
          {
            "$ref": "#/components/parameters/propertyKey"
          }
        ],
        "responses": {
          "200": {
            "description": "The single property update was applied successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PropertiesDocument"
                },
                "example": [
                  {
                    "createdAt": 1490956159587,
                    "timestamp": 1490956159587,
                    "key": "temperature_celcius",
                    "value": 33
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PropertiesDocument"
              },
              "example": [
                {
                  "key": "test_key",
                  "value": 33
                }
              ]
            }
          },
          "description": "The request body for updating a single property.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Properties"
        ],
        "summary": "Read a Thng property",
        "description": "Read a single Thng property. By default, all the updates of this property are returned using pagination in a reverse history fashion (the first element of the returned array is the latest update). For accessing only a subset of all the updates to a single property, you can specify a time range using `?from=Timestamp` and `?to=Timestamp` to specify respectively the beginning and end of the time window. You will receive an array of all the property updates during this time.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          },
          {
            "$ref": "#/components/parameters/propertyKey"
          },
          {
            "$ref": "#/components/parameters/from"
          },
          {
            "$ref": "#/components/parameters/to"
          }
        ],
        "responses": {
          "200": {
            "description": "The property was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PropertiesDocument"
                },
                "example": [
                  {
                    "createdAt": 1490956159587,
                    "timestamp": 1490956159587,
                    "value": 33
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ]
      },
      "delete": {
        "tags": [
          "Properties"
        ],
        "summary": "Delete a Thng property",
        "description": "Delete a Thng property. Property updates are not uniquely identified (do not have their own URL). Therefore, the only way to delete data points is to append the `?to=Timestamp` URL query parameter to specify a point in time before which all the data points will be removed. If the `?to=` parameter is not specified, ALL updates of this property will be deleted!",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          },
          {
            "$ref": "#/components/parameters/propertyKey"
          },
          {
            "$ref": "#/components/parameters/to"
          }
        ],
        "responses": {
          "200": {
            "description": "The property was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/thngs/{thngId}/properties": {
      "post": {
        "tags": [
          "Properties"
        ],
        "summary": "Create/update Thng properties",
        "description": "Create/update Thng properties. When a resource is created, you can specify an initial set of properties and their values. To update those properties or to add new ones, use a `PUT` request with an array of `PropertyDocument` JSON objects containing the changed fields. If the properties updated do not exist, they are created automatically by this request and no error/notification will be returned.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The property updates were applied successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PropertiesDocument"
                },
                "example": [
                  {
                    "createdAt": 1490953506826,
                    "timestamp": 1490953506826,
                    "key": "temperature_celsius",
                    "value": 33
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PropertiesDocument"
              },
              "example": [
                {
                  "key": "test_key",
                  "value": 33
                }
              ]
            }
          },
          "description": "The request body for updating properties.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Properties"
        ],
        "summary": "Read all Thng properties",
        "description": "Read all properties on a Thng.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "An array of properties of this Thng.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PropertyDocument"
                  }
                },
                "example": [
                  {
                    "createdAt": 1490955243760,
                    "timestamp": 1490955243760,
                    "key": "temperature_celsius",
                    "value": 33
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ]
      }
    },
    "/thngs/{thngId}": {
      "get": {
        "tags": [
          "Thngs"
        ],
        "summary": "Read a Thng",
        "description": "Read a single Thng by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Thng, if available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ThngDocument"
                },
                "example": {
                  "id": "UkNCRED7BDPaQKRRwhAnPaQn",
                  "createdAt": 1490356077941,
                  "updatedAt": 1491234759285,
                  "name": "Action Thng"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ]
      },
      "put": {
        "tags": [
          "Thngs"
        ],
        "summary": "Update a Thng",
        "description": "Update a Thng by ID. Only the basic fields (`name`, `description`, `product`, `identifiers`, `tags`, and `customFields`) can be updated in this manner. Properties, location and collections must be updated via their respective `/thngs/:thngId/location`, `/thngs/:thngId/properties` and `/collections/:collectionId/thngs` endpoints.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Thng was updated successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ThngDocument"
                },
                "example": {
                  "id": "UkNCRED7BDPaQKRRwhAnPaQn",
                  "createdAt": 1490356077941,
                  "updatedAt": 1491236784044,
                  "name": "Action Thng",
                  "description": "Updated description"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User",
          "Device"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ThngDocument"
              },
              "example": {
                "description": "Updated Thng description.",
                "tags": [
                  "updated"
                ]
              }
            }
          },
          "description": "The request body for updating a Thng.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Thngs"
        ],
        "summary": "Delete a Thng",
        "description": "Delete a Thng by ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/thngId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Thng was deleted successfully."
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    },
    "/thngs": {
      "post": {
        "tags": [
          "Thngs"
        ],
        "summary": "Create a Thng",
        "description": "Create a new Thng.",
        "responses": {
          "201": {
            "description": "The Thng was created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ThngDocument"
                },
                "example": {
                  "id": "UFsyXmXCVq8NtrRwREMfGaSs",
                  "createdAt": 1491233125432,
                  "updatedAt": 1491233125432,
                  "name": "TestThng"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ThngDocument"
              },
              "example": {
                "name": "Test Thng",
                "description": "Test Thng description"
              }
            }
          },
          "description": "The request body for creating a Thng.",
          "required": true
        }
      },
      "get": {
        "tags": [
          "Thngs"
        ],
        "summary": "Read all Thngs",
        "description": "Read all Thngs.",
        "responses": {
          "200": {
            "description": "An array of all available Thngs, paginated as required.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ThngDocument"
                  }
                },
                "example": [
                  {
                    "id": "UkMMaXbaBDPatKawRDhCwmxm",
                    "createdAt": 1489765904266,
                    "updatedAt": 1489765904266,
                    "name": "Detector 3",
                    "properties": {}
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ]
      }
    },
    "/users/login": {
      "post": {
        "tags": [
          "Application Users"
        ],
        "summary": "Log In with Access Info",
        "description": "Log an Application User in and obtain access details.",
        "responses": {
          "200": {
            "description": "The log in was successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserDocument"
                },
                "example": {
                  "id": "UGCMtpXfqQQBYPRwahgnwPnc",
                  "createdAt": 1499265893463,
                  "updatedAt": 1499265908969,
                  "email": "test@evrythng.com",
                  "firstName": "Test",
                  "lastName": "User",
                  "project": "U2As9WsMthW5F5aeFECpCeDs",
                  "app": "UFUstWQVQEC5FpRe2EWpWBhf",
                  "access": {
                    "id": "595cfb74b4a46a2c00b7b6d5",
                    "project": "U2As9WsMthW5F5aeFECpCeDs",
                    "app": "UFUstWQVQEC5FpRe2EWpWBhf",
                    "user": "UGCMtpXfqQQBYPRwahgnwPnc",
                    "actor": "UGCMtpXfqQQBYPRwahgnwPnc",
                    "role": "592d70418c5e3f2800408a74",
                    "apiKey": "N8tUbOLK4B5RD3VIXoJs05DkP4lrE1RE3WbChQw7..."
                  }
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Trusted Application",
          "Application"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationUserLoginDocument"
              },
              "example": {
                "email": "test@email.com",
                "password": "M7@29P6Stk9zF5gX5@4!c3Vm"
              }
            }
          },
          "description": "The Application User's email and password to log in again.",
          "required": true
        }
      }
    },
    "/users/{evrythngUser}/status": {
      "get": {
        "tags": [
          "Application Users"
        ],
        "summary": "Read an Application User's activation status",
        "description": "Read a single Application User's activation status but their `evrythngUser` ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/evrythngUser"
          }
        ],
        "responses": {
          "200": {
            "description": "The Application User's status was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserStatusDocument"
                },
                "example": {
                  "activated": true,
                  "activationDate": 1515598555651
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User"
        ]
      }
    },
    "/users/{evrythngUser}": {
      "get": {
        "tags": [
          "Application Users"
        ],
        "summary": "Read an Application User",
        "description": "Read a single Application User but their `evrythngUser` ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/evrythngUser"
          }
        ],
        "responses": {
          "200": {
            "description": "The Application User was read successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserDocument"
                },
                "example": {
                  "id": "UGN5FtfdV6PNQ7aRaXwCrhHp",
                  "createdAt": 1507561299992,
                  "updatedAt": 1507561300298,
                  "email": "appuser-1507561299766@example.com",
                  "firstName": "Example",
                  "lastName": "User",
                  "project": "UmrK2QWAegPwQ5waRh4QMQfp",
                  "app": "UGr5kQCUBMsr9NwwR2wPeKbe"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application",
          "Application User"
        ]
      },
      "put": {
        "tags": [
          "Application Users"
        ],
        "summary": "Update an Application User",
        "description": "Update an existing Application User by their `evrythngUser` ID. Authorised Application Users can modify their own data (including the password) using their API key.",
        "parameters": [
          {
            "$ref": "#/components/parameters/evrythngUser"
          }
        ],
        "responses": {
          "200": {
            "description": "The Application User was updated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApplicationUserDocument"
                },
                "example": {
                  "id": "Uka3sDEB6B7SyCDqqYDNHdfs",
                  "createdAt": 1477043828768,
                  "updatedAt": 1490780828406,
                  "email": "population1@test.com",
                  "firstName": "UPdated",
                  "lastName": "One",
                  "project": "Uh5qRBqc4DcmbNbAANtMnrYm",
                  "app": "Uh6GfhFnmgScpnxwMsqmbbBk"
                }
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Application User"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApplicationUserDocument"
              },
              "example": {
                "firstName": "Test",
                "lastName": "Testers",
                "password": "P@ssw0rd!",
                "oldPassword": "P@ssw0rd"
              }
            }
          },
          "description": "The ApplicationUserDocument with fields to update.",
          "required": true
        }
      },
      "delete": {
        "tags": [
          "Application Users"
        ],
        "summary": "Delete an Application User",
        "description": "Delete an Application User by its `evrythngUser` ID.",
        "parameters": [
          {
            "$ref": "#/components/parameters/evrythngUser"
          }
        ],
        "responses": {
          "200": {
            "description": "The Application User was deleted."
          }
        },
        "x-api-keys": [
          "Operator"
        ]
      }
    },
    "/users": {
      "get": {
        "tags": [
          "Application Users"
        ],
        "summary": "Read all Application Users",
        "description": "Read all visible application users.",
        "responses": {
          "200": {
            "description": "An array of all visible Application Users.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApplicationUserDocument"
                  }
                },
                "example": [
                  {
                    "id": "Uka3sDEB6B7SyCDqqYDNHdfs",
                    "createdAt": 1477043828768,
                    "updatedAt": 1477043893319,
                    "email": "testuser@test.com",
                    "firstName": "Test",
                    "lastName": "User",
                    "project": "Uh5qRBqc4DcmbNbAANtMnrYm",
                    "app": "Uh6GfhFnmgScpnxwMsqmbbBk"
                  }
                ]
              }
            }
          }
        },
        "x-api-keys": [
          "Operator",
          "Trusted Application"
        ]
      }
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "externalDocs": {
    "description": "EVRYTHNG Developer Hub",
    "url": "https://developers.evrythng.com"
  },
  "x-explorer-enabled": false,
  "x-samples-languages": [
    "curl",
    "node",
    "java",
    "python"
  ],
  "servers": [
    {
      "url": "https://api.evrythng.com"
    }
  ],
  "components": {
    "parameters": {
      "accessId": {
        "name": "accessId",
        "in": "path",
        "description": "An access ID.",
        "required": true,
        "example": "{accessId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "accessPolicyId": {
        "name": "accessPolicyId",
        "in": "path",
        "description": "The unique access policy identifier",
        "example": "UNEdEQ5nFdMYPPyQxTcNqfnb",
        "required": true,
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "accountId": {
        "name": "accountId",
        "in": "path",
        "description": "An account ID.",
        "required": true,
        "example": "{accountId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "actionId": {
        "name": "actionId",
        "in": "path",
        "required": true,
        "description": "An action ID.",
        "example": "{actionId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "actionType": {
        "name": "actionType",
        "in": "path",
        "required": true,
        "description": "An action type name.",
        "example": "{actionType}",
        "schema": {
          "type": "string"
        }
      },
      "adiOrderId": {
        "name": "adiOrderId",
        "in": "path",
        "required": true,
        "description": "A 24 character EVRYTHNG resource ID for the ADI Order.",
        "example": "U5DBbKK5mXQBVeaaa4xqpp2t",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "applicationId": {
        "name": "applicationId",
        "in": "path",
        "required": true,
        "description": "An application ID.",
        "example": "{applicationId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "batchId": {
        "name": "batchId",
        "in": "path",
        "required": true,
        "description": "A batch ID.",
        "example": "{batchId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "childCollectionId": {
        "name": "childCollectionId",
        "in": "path",
        "required": true,
        "description": "A collection ID.",
        "example": "{childCollectionId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "clientId": {
        "name": "clientId",
        "in": "path",
        "required": true,
        "description": "An OAuth client ID.",
        "example": "{clientId}",
        "schema": {
          "type": "string",
          "minLength": 45,
          "maxLength": 45
        }
      },
      "collectionId": {
        "name": "collectionId",
        "in": "path",
        "required": true,
        "description": "A collection ID.",
        "example": "{collectionId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "containerId": {
        "name": "containerId",
        "in": "path",
        "required": true,
        "description": "The shipment notice container ID.",
        "schema": {
          "type": "string"
        }
      },
      "datasetId": {
        "description": "The ID of the dataset",
        "required": true,
        "schema": {
          "title": "Datasetid",
          "type": "string",
          "description": "The ID of the dataset",
          "example": "4aba66f95b8d410c9c510867d6533844"
        },
        "name": "datasetId",
        "in": "path"
      },
      "deploymentId": {
        "description": "The ID of the deployed endpoint",
        "schema": {
          "title": "Deploymentid",
          "type": "string",
          "description": "The ID of the deployed model",
          "example": "a18d388b371c4c17b87bcf44750ce222"
        },
        "name": "deploymentId",
        "required": true,
        "in": "path"
      },
      "evrythngUser": {
        "name": "evrythngUser",
        "in": "path",
        "required": true,
        "description": "An application User ID.",
        "example": "{evrythngUser}",
        "schema": {
          "type": "string"
        }
      },
      "fileId": {
        "name": "fileId",
        "in": "path",
        "required": true,
        "description": "A file ID.",
        "example": "{fileId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "filter": {
        "name": "filter",
        "in": "query",
        "description": "The filter query parameter.",
        "schema": {
          "type": "string"
        }
      },
      "from": {
        "name": "from",
        "in": "query",
        "description": "From timestamp.",
        "schema": {
          "type": "integer",
          "minimum": 0
        }
      },
      "ids": {
        "name": "ids",
        "in": "query",
        "description": "Comma-separated list of resource ids to return.",
        "example": "UNEdEQ5nFdMYPPyQxTcNqfnb,UNEdEQ6nFdMYPPyQxTcNqfnb",
        "schema": {
          "type": "string"
        }
      },
      "latitude": {
        "name": "lat",
        "in": "query",
        "description": "The latitude of the query.",
        "schema": {
          "type": "number"
        }
      },
      "longitude": {
        "name": "lon",
        "in": "query",
        "description": "The longitude of the query.",
        "schema": {
          "type": "number"
        }
      },
      "maxDistance": {
        "name": "maxDist",
        "in": "query",
        "description": "The maximum distance from the query origin in kilometers.",
        "schema": {
          "type": "integer"
        }
      },
      "modelId": {
        "description": "The ID of the model which will be deployed",
        "schema": {
          "type": "string",
          "example": "fd168d2ac56f45619af2cb1de1a37ac2"
        },
        "name": "modelId",
        "required": true,
        "in": "path"
      },
      "modelType": {
        "description": "The type of model that will be deployed",
        "schema": {
          "title": "Modeltype",
          "type": "string",
          "description": "The type of model that will be deployed",
          "example": "scans"
        },
        "name": "modelType",
        "in": "path",
        "required": true
      },
      "nextPageToken": {
        "in": "query",
        "name": "nextPageToken",
        "description": "The pagination parameter used to address the next page of results.",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "operatorAccessId": {
        "name": "operatorAccessId",
        "in": "path",
        "description": "An operator access ID.",
        "required": true,
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "orderEventId": {
        "name": "orderEventId",
        "in": "path",
        "required": true,
        "description": "A 24 character EVRYTHNG resource ID for the ADI Order event.",
        "example": "U5DBbKK5mXQBVeaaa4xqpp2t",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "perPage": {
        "in": "query",
        "name": "perPage",
        "description": "The pagination parameter specifying the number of resources to return in one response.",
        "required": false,
        "schema": {
          "type": "number"
        }
      },
      "placeId": {
        "name": "placeId",
        "in": "path",
        "required": true,
        "description": "A place ID.",
        "example": "{placeId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "productId": {
        "name": "productId",
        "in": "path",
        "required": true,
        "description": "A product ID.",
        "example": "{productId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "projectId": {
        "name": "projectId",
        "in": "path",
        "required": true,
        "description": "A project ID.",
        "example": "{projectId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "propertyKey": {
        "name": "propertyKey",
        "in": "path",
        "required": true,
        "description": "A property key.",
        "example": "{propertyKey}",
        "schema": {
          "type": "string"
        }
      },
      "purchaseOrderId": {
        "name": "purchaseOrderId",
        "in": "path",
        "description": "The unique purchase order identifier. May also be the evrythngId from the purchase order.",
        "example": "1234567890",
        "required": true,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 32,
          "pattern": "^[a-zA-Z0-9_+-.@]+$"
        }
      },
      "roleId": {
        "name": "roleId",
        "in": "path",
        "required": true,
        "description": "A role ID.",
        "example": "{roleId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "scanFilter": {
        "name": "scanFilter",
        "in": "query",
        "description": "The filter query parameter for Identifier Recognition requests.\nFor POST requests, the filter must contain 'method' and 'type' using values as detailed below:\n\nmethod: 1d\ntypes: codabar, code_11, code_39, code_93, ean_8, ean_13, industr_25, itf, rss_14, rss_expanded, rss_limited, upc_a, upc_e\n\nmethod: 2d\ntypes: qr_code, dm\n\nmethod: ir\ntypes: image\n\nmethod: ocr\ntypes: text\n\nmethod: digimarc\ntypes: gs1:01, gs1:21\n",
        "schema": {
          "type": "string"
        }
      },
      "scheduleId": {
        "name": "scheduleId",
        "in": "path",
        "required": true,
        "description": "A Reactor schedule ID.",
        "example": "{scheduleId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "shipmentNoticeId": {
        "name": "shipmentNoticeId",
        "in": "path",
        "required": true,
        "description": "The shipment notice ID.",
        "schema": {
          "type": "string"
        }
      },
      "shortId": {
        "name": "shortId",
        "in": "path",
        "required": true,
        "description": "A short ID for use in redirections.",
        "example": "{shortId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{8,10}$"
        }
      },
      "sortOrder": {
        "name": "sortOrder",
        "in": "query",
        "description": "The pagination parameter specifying the order of sorting of resources to return. The descending order is used by default, but ascending is also available. To specify a preference, use with a value of DESCENDING or ASCENDING.",
        "example": "DESCENDING",
        "schema": {
          "type": "string"
        }
      },
      "taskId": {
        "name": "taskId",
        "in": "path",
        "required": true,
        "description": "A task ID.",
        "example": "{taskId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "thngId": {
        "name": "thngId",
        "in": "path",
        "required": true,
        "description": "A Thng ID.",
        "example": "{thngId}",
        "schema": {
          "type": "string",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        }
      },
      "thngIdentifier": {
        "name": "thngIdentifier",
        "in": "path",
        "description": "Any valid Thng ID or identifier string separated by ':'.",
        "required": true,
        "example": "gs1:21:02374837684278",
        "schema": {
          "type": "string"
        }
      },
      "to": {
        "name": "to",
        "in": "query",
        "description": "To timestamp.",
        "schema": {
          "type": "integer",
          "minimum": 0
        }
      },
      "useEvrythngId": {
        "in": "query",
        "name": "useEvrythngId",
        "schema": {
          "type": "boolean"
        },
        "description": "Set to 'true' to use the generated 'evrythngId' as 'id' for purchase orders, or 'asnId' for shipment notices."
      },
      "withErrors": {
        "in": "query",
        "name": "withErrors",
        "description": "If set to true the response will contain status with error details.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      }
    },
    "requestBodies": {},
    "securitySchemes": {
      "Authorization": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "ADIOrderDocument": {
        "description": "Object describing the order of ADIs to generate.",
        "type": "object",
        "required": [
          "metadata",
          "purchaseOrder"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "status": {
            "$ref": "#/components/schemas/ADIOrderStatusDocument"
          },
          "result": {
            "type": "string",
            "description": "The result of the order once it has been completed.",
            "enum": [
              "SUCCEEDED",
              "FAILED",
              "SUCCEEDED_WITH_FAILURES"
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/ADIOrderMetadataDocument"
          },
          "purchaseOrder": {
            "type": "string",
            "description": "ID of the associated purchase order.",
            "example": 7328468
          },
          "ids": {
            "type": "array",
            "description": "Array of string IDs to be used for each generated ADI.",
            "items": {
              "type": "string"
            },
            "uniqueItems": true,
            "example": [
              "827bd8a2",
              "897c9a7d",
              "90ab78a6"
            ]
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "idGeneration": {
            "$ref": "#/components/schemas/ADIOrderIDGenerationDocument"
          },
          "fileMetadata": {
            "$ref": "#/components/schemas/ADIOrderFileMetadataDocument"
          },
          "results": {
            "$ref": "#/components/schemas/ADIOrderResultsDocument"
          }
        }
      },
      "ADIOrderErrorDetailsDocument": {
        "type": "object",
        "description": "Details of the error of the particular identifier processing.",
        "properties": {
          "code": {
            "type": "number",
            "description": "The code of the error.",
            "example": 80300010
          },
          "error": {
            "type": "string",
            "description": "The error message.",
            "example": "An identity with that Identifier and ADI order already exists for that same account"
          }
        }
      },
      "ADIOrderErrorsDocument": {
        "type": "object",
        "description": "The list of errors. Key - the identifier value, the value - ADIOrderErrorDetailsDocument."
      },
      "ADIOrderEventDocument": {
        "description": "Object containing action details and IDs of ADIs to create actions for.",
        "type": "object",
        "required": [
          "metadata",
          "ids"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "id of adi order event",
            "example": "U7x9gTmMRFEaSHxMC5g8bqSd"
          },
          "status": {
            "$ref": "#/components/schemas/ADIOrderEventStatusDocument"
          },
          "result": {
            "type": "string",
            "description": "adi order event processing result",
            "enum": [
              "succeeded",
              "failed",
              "succeeded_with_failures"
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/ActionDocument"
          },
          "ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "array of ADIs' ids to create actions for",
            "example": [
              "ad76as8d7ga",
              "ad87ad6fg8a7f"
            ]
          },
          "customFields": {
            "type": "object",
            "description": "Object of case-sensititve key-value pairs of custom fields associated with the resource."
          },
          "identifiers": {
            "type": "object",
            "description": "Various identifiers (EPC, ISBN, etc.) as a JSON object with one or more key-value pairs."
          },
          "tags": {
            "type": "array",
            "description": "Array of string tags associated with this resource.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ADIOrderEventStatusDocument": {
        "type": "object",
        "description": "Object describing the status of an ADI order event",
        "properties": {
          "state": {
            "type": "string",
            "description": "The state of the order event.",
            "enum": [
              "pending",
              "in_progress",
              "completed"
            ]
          },
          "requested": {
            "type": "integer",
            "description": "Number of actions requested for identifiers of adi order."
          },
          "events": {
            "$ref": "#/components/schemas/ADIOrderProgressDocument"
          }
        }
      },
      "ADIOrderFileCsvMetadataDocument": {
        "type": "object",
        "description": "Contains configuration parameters for txt file generation.",
        "properties": {
          "columns": {
            "type": "array",
            "description": "Set of characteristics of the ADI to be written in one row of the csv file.",
            "items": {
              "type": "string",
              "enum": [
                "digitalLink",
                "shortUrl",
                "identifier",
                "product"
              ]
            },
            "example": [
              "product",
              "identifier",
              "shortUrl",
              "digitalLink"
            ]
          },
          "digitalLinkDomain": {
            "type": "string",
            "example": "https://pxgkp.tn.gg",
            "description": "This url will be used for constructing digital link of ADI in a file if \"columns\" array contains \"digitalLink\"."
          }
        }
      },
      "ADIOrderFileErrorsDocument": {
        "type": "object",
        "description": "Link to file with errors happened during ADI generation.",
        "properties": {
          "json": {
            "type": "string",
            "description": "Link to the json file with errors.",
            "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/errors-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
          }
        }
      },
      "ADIOrderFileIdentifiersDocument": {
        "type": "object",
        "description": "Links to files with identifiers.",
        "properties": {
          "csv": {
            "type": "string",
            "description": "Link to csv file.",
            "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.csv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2d77b9636382476ed152b848eef3b44dbc75961827a027cafb8dab935e5bd312"
          },
          "txt": {
            "type": "string",
            "description": "Link to txt file.",
            "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d176238e2f99a925f6903e1abea25c81a9a719b8cd952cc71c407b5f111463f0"
          },
          "json": {
            "type": "string",
            "description": "Link to json file.",
            "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
          }
        }
      },
      "ADIOrderFileMetadataDocument": {
        "type": "object",
        "description": "Contains configuration required for file generation.",
        "properties": {
          "csv": {
            "$ref": "#/components/schemas/ADIOrderFileCsvMetadataDocument"
          },
          "txt": {
            "$ref": "#/components/schemas/ADIOrderFileTxtMetadataDocument"
          }
        }
      },
      "ADIOrderFileTxtMetadataDocument": {
        "type": "object",
        "description": "Contains configuration parameters for txt file generation.",
        "properties": {
          "value": {
            "type": "string",
            "description": "Characteristic of the ADI. The value of this field will refer to ADI in the generated file.",
            "enum": [
              "digitalLink",
              "shortUrl",
              "identifier",
              "product"
            ],
            "example": "digitalLink"
          },
          "digitalLinkDomain": {
            "type": "string",
            "example": "https://pxgkp.tn.gg",
            "description": "This url will be used for constructing digital link of the ADI in a file if \"value\" equals to the digitalLink."
          },
          "perLine": {
            "type": "number",
            "description": "Number of identifiers per line in the generated file.",
            "example": 3
          },
          "separator": {
            "type": "string",
            "description": "Character or sequence of characters to be used for separation of identifiers located in one line.",
            "example": "|"
          },
          "newLine": {
            "type": "string",
            "description": "Character or sequence of characters to be used as the end of the line.",
            "example": "\\r\\n"
          }
        }
      },
      "ADIOrderIDGenerationDocument": {
        "type": "object",
        "description": "Metadata of the set of IDs for generation.",
        "required": [
          "length",
          "quantity"
        ],
        "properties": {
          "prefix": {
            "type": "string",
            "example": "xz1",
            "description": "The prefix of every ID to be generated."
          },
          "suffix": {
            "type": "string",
            "example": "xz2",
            "description": "The suffix of every ID to be generated."
          },
          "characterSet": {
            "type": "string",
            "description": "The character set to be used for ID generation. Default value is 'AN-47'.",
            "example": "AN-47",
            "enum": [
              "GS1-64w",
              "AN-47",
              "UAN-28",
              "GS1-36w"
            ]
          },
          "length": {
            "type": "number",
            "description": "The length of ID part which is going to be generated. Does not include 'prefix' and 'suffix' if were set. Allowed values are in range 8..20",
            "example": 8
          },
          "quantity": {
            "type": "number",
            "description": "The quantity of IDs to be generated. Maximal allowed value is 20000.",
            "example": 10000
          }
        }
      },
      "ADIOrderMetadataDocument": {
        "type": "object",
        "description": "Metadata describing data to include in the created Thngs and their redirections.",
        "required": [
          "identifierKey"
        ],
        "properties": {
          "targetAccount": {
            "type": "string",
            "example": "UfwwwypHPeKwYNbCXN1N5wcp",
            "description": "The ID of the account for which the ADIs were created."
          },
          "identifierKey": {
            "type": "string",
            "example": "gs1:21",
            "description": "The key which will be used in the `identifiers` object on the `Thng` to store the ID. For example, `gs1:21`."
          },
          "product": {
            "type": "string",
            "description": "Identifier string for the product to which the created ADI (Thng) will be associated. Can be either a product ID  (e.g: 'U4tqeXsDe6sN9NawR3ywFgYn') or colon separated identfier (e.g: 'gs1:01:12345678901234').",
            "example": "gs1:01:12345678901234"
          },
          "identifiers": {
            "type": "object",
            "description": "Key-value pairs of custom additional identifiers to include on the Thngs.",
            "example": {
              "internalOrderId": "123456"
            }
          },
          "customFields": {
            "type": "object",
            "description": "Key-value pairs of custom fields to include on the Thngs.",
            "example": {
              "color": "red"
            }
          },
          "tags": {
            "description": "Array of string tags to be added to include on the Thng.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "shipped",
              "received"
            ]
          },
          "shortDomain": {
            "type": "string",
            "example": "tn.gg",
            "description": "Short domain use in creating Thng redirections."
          },
          "defaultRedirectUrl": {
            "type": "string",
            "example": "https://evrythng.com?thng={evrythngId}",
            "description": "Default URL to redirect to. Placeholders can be used: {evrythngId} for the Thng ID or {shortId} for the short ID."
          },
          "project": {
            "type": "string",
            "description": "If specified, the Thngs created will be scoped to the project with this ID.",
            "example": "U5gBSMUHxpwHEsawaFdrnbkf",
            "minLength": 24,
            "maxLength": 24
          }
        }
      },
      "ADIOrderProgressDocument": {
        "type": "object",
        "description": "Creation progress and errors",
        "properties": {
          "created": {
            "type": "integer",
            "description": "Number of actions created."
          },
          "pending": {
            "type": "integer",
            "description": "Number of actions waiting for creation."
          },
          "errorsCount": {
            "type": "integer",
            "description": "Number of errors occurred."
          },
          "errors": {
            "$ref": "#/components/schemas/ADIOrderErrorsDocument"
          }
        }
      },
      "ADIOrderResultsDocument": {
        "type": "object",
        "description": "Object containing links to generated files.",
        "properties": {
          "identifiers": {
            "$ref": "#/components/schemas/ADIOrderFileIdentifiersDocument"
          },
          "errors": {
            "$ref": "#/components/schemas/ADIOrderFileErrorsDocument"
          }
        }
      },
      "ADIOrderStatusDocument": {
        "type": "object",
        "description": "Object describing the status of an ADI order. Returned only when a single order is read by ID.",
        "properties": {
          "state": {
            "type": "string",
            "description": "The state of the order.",
            "enum": [
              "pending",
              "in_progress",
              "completed"
            ]
          },
          "requested": {
            "type": "integer",
            "description": "Number of requested identifiers."
          },
          "adis": {
            "$ref": "#/components/schemas/ADIOrderProgressDocument"
          }
        }
      },
      "AccessDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an account's access record.",
        "readOnly": true,
        "properties": {
          "account": {
            "type": "string",
            "description": "The account ID.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "apiKey": {
            "type": "string",
            "description": "The account's Operator API key.",
            "readOnly": true,
            "pattern": "^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789]{80}$"
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "operator": {
            "type": "string",
            "description": "The account's user ID.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "role": {
            "type": "string",
            "description": "The ID of the currently assigned role.",
            "minLength": 4,
            "maxLength": 24
          }
        }
      },
      "AccessPolicyDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An access policy resource.",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "description": "The name of the policy.",
            "type": "string",
            "example": "FactoryAdministratorPolicy",
            "minLength": 5,
            "maxLength": 128,
            "pattern": "^[a-zA-Z0-9:\\\\._\\\\s-]+$"
          },
          "permissions": {
            "description": "A list of combinations of resource and type of access.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccessPolicyPermissionField"
            }
          },
          "uiPermissions": {
            "description": "A list of UI permissions",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "homepage": {
            "description": "The homepage to display in the UI.  The homepage must be included in the uiPermissions list within the current access policy document.",
            "type": "string",
            "example": "adiOrders",
            "minLength": 1,
            "maxLength": 128
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "identifiers.<key>",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "AccessPolicyPermissionField": {
        "description": "An access policy permission. Each must include an resource type, such as places or thngs, and one or more types of access from create, list, read, update, and delete.",
        "type": "string",
        "example": "places:list,read,update",
        "minLength": 3,
        "maxLength": 256,
        "pattern": "^[a-zA-Z0-9\\\\.]+:[a-z\\\\,\\\\*]+$"
      },
      "AccessTokenDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a service access.",
        "readOnly": true,
        "required": [
          "name",
          "conditions",
          "policies"
        ],
        "properties": {
          "name": {
            "description": "The name of the access token.",
            "type": "string",
            "example": "operator@email.com",
            "minLength": 5,
            "maxLength": 128
          },
          "description": {
            "description": "The description of the access token.  Which services this token might be applied to.",
            "type": "string",
            "maxLength": 256
          },
          "policies": {
            "description": "An array of policy IDs",
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 24,
              "maxLength": 24
            },
            "uniqueItems": true,
            "maxItems": 100
          },
          "conditions": {
            "description": "A conditions array.",
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 3,
              "maxLength": 128,
              "pattern": "^[A-Za-z0-9_-]+:[A-Za-z0-9_-]+$"
            },
            "maxItems": 256,
            "uniqueItems": true
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          }
        }
      },
      "AccountConfigurationDocument": {
        "type": "object",
        "description": "Object containing account related configuration.",
        "properties": {
          "uniqueIdentifiers": {
            "$ref": "#/components/schemas/AccountUniqueIdentifiersDocument"
          }
        }
      },
      "AccountDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a Platform account.",
        "properties": {
          "name": {
            "$ref": "#/components/schemas/AccountNameField"
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "imageUrl": {
            "type": "string",
            "description": "The account Dashboard logo."
          },
          "tfaRequired": {
            "type": "boolean",
            "description": "Whether two-factor authentication is required for this account.",
            "readOnly": true
          },
          "defaultUrl": {
            "type": "string",
            "description": "Invalid GS1 scans will redirect to this URL."
          },
          "configuration": {
            "$ref": "#/components/schemas/AccountConfigurationDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "AccountNameField": {
        "type": "string",
        "description": "Friendly name of this resource. Must be between 1 and 30 characters.",
        "minLength": 1,
        "maxLength": 30
      },
      "AccountRedirectorRuleDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object containing a single Redirector rule set.",
        "properties": {
          "match": {
            "type": "string",
            "description": "Filter used to evaluate this rule. Will always match if this field is not set."
          },
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "redirectUrl": {
            "type": "string",
            "description": "URL to redirect to if the rule matches."
          },
          "delegates": {
            "description": "Array of app and/or project delegates that will receive this redirection if necessary.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DelegateDocument"
            }
          },
          "constants": {
            "type": "object",
            "description": "Key-value pairs (both must be strings). User can add as many as needed."
          }
        }
      },
      "AccountRedirectorRulesDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing the account's Redirector rules",
        "required": [
          "rules"
        ],
        "properties": {
          "rules": {
            "description": "The rules set up for a Redirector.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccountRedirectorRuleDocument"
            }
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          }
        }
      },
      "AccountUniqueIdentifiersDocument": {
        "type": "object",
        "description": "Object containing lists of identifier keys which meant to be unique for a particular entity",
        "properties": {
          "products": {
            "type": "array",
            "description": "array of identifier keys meant to be unique for product entity. Identifiers\nused in product \"identifiers\" field will be concatenated in the order specified in the\n\"products\" array and used as unique identifier for a given product which means that user\nwill not be able to create two products with the same unique identifiers.",
            "items": {
              "type": "string"
            },
            "example": [
              "gs1:01",
              "gs1:22",
              "customCompanyId"
            ]
          }
        }
      },
      "ActionContextDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object containing contextual data about the action creator.",
        "properties": {
          "ipAddress": {
            "type": "string",
            "description": "The geolocation IP address of the action.",
            "readOnly": true
          },
          "city": {
            "type": "string",
            "description": "The geolocation city of the action, based on the IP address.",
            "readOnly": true
          },
          "region": {
            "type": "string",
            "description": "The wider region of the action.",
            "readOnly": true
          },
          "countryCode": {
            "type": "string",
            "description": "The country of the action.",
            "readOnly": true
          },
          "userAgentName": {
            "type": "string",
            "description": "The user agent name of the action creator's browser or other client.",
            "readOnly": true
          },
          "userAgent": {
            "type": "string",
            "description": "The user agent of the action creator's browser or other client.",
            "readOnly": true
          },
          "operatingSystemName": {
            "type": "string",
            "description": "Name of the action creator's client operating system.",
            "readOnly": true
          },
          "timeZone": {
            "type": "string",
            "description": "The timezone string, such as Europe/Paris",
            "readOnly": true
          }
        }
      },
      "ActionDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a Platform action.",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "The action type."
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "user": {
            "type": "string",
            "description": "The EVRYTHNG ID of the user who has performed this action.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "createdByProject": {
            "type": "string",
            "description": "The EVRYTHNG ID of the project who has performed this action.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "createdByApp": {
            "type": "string",
            "description": "The EVRYTHNG ID of the application who has performed this action.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "thng": {
            "type": "string",
            "description": "The EVRYTHNG ID of the Thng this action was carried out on.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "product": {
            "type": "string",
            "description": "The EVRYTHNG product ID associated with the Thng this action was carried out on.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "collection": {
            "type": "string",
            "description": "The EVRYTHNG ID of the collection this action was carried out on. Custom action types only.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "timestamp": {
            "type": "integer",
            "description": "The timestamp when the action took place. Filled automatically if unspecified.",
            "readOnly": true,
            "minimum": 0
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "location": {
            "$ref": "#/components/schemas/LocationDocument"
          },
          "locationSource": {
            "type": "string",
            "description": "The method used to find the location where the action took place, and requires `location` to also be set. If a GPS was used (with user permission granted), `sensor` is specified. Otherwise an estimate is made based on the apparent location, which may not be the device itself.",
            "enum": [
              "sensor",
              "geoIp",
              "unknown",
              "place"
            ]
          },
          "context": {
            "$ref": "#/components/schemas/ActionContextDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "reactions": {
            "type": "array",
            "description": "An array of Redirector reactions that occured from this action.",
            "items": {
              "$ref": "#/components/schemas/ReactionDocument"
            }
          },
          "url": {
            "type": "string",
            "description": "The URL to the triggering scan, added in some cases."
          }
        },
        "x-filterable-fields": [
          {
            "name": "timestamp",
            "type": "number",
            "operators": [
              ">",
              "<"
            ]
          },
          {
            "name": "identifiers.<key>",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          },
          {
            "name": "type",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "user",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "context.city",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "context.countryCode",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "thng",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "product",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "collection",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "ActionTypeDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing a custom action type.",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the action type. Custom action types must begin with an underscore."
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "ActivationCodeDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The payload for activating an unactivated Application User.",
        "required": [
          "activationCode"
        ],
        "properties": {
          "activationCode": {
            "type": "string",
            "description": "The activation code to use.",
            "readOnly": true
          }
        }
      },
      "ActorDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object describing an actor.",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the actor",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "type": {
            "type": "string",
            "description": "Type of actor.",
            "enum": [
              "operator",
              "userInApp",
              "app",
              "device"
            ],
            "readOnly": true
          }
        }
      },
      "AddressDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a street address.",
        "properties": {
          "extension": {
            "type": "string",
            "description": "The extension of the address."
          },
          "street": {
            "type": "string",
            "description": "The street of the address."
          },
          "postalCode": {
            "type": "string",
            "description": "The postal code of the address."
          },
          "city": {
            "type": "string",
            "description": "The city of the address."
          },
          "county": {
            "type": "string",
            "description": "The county of the address."
          },
          "state": {
            "type": "string",
            "description": "The state of the address."
          },
          "country": {
            "type": "string",
            "description": "The country of the address."
          },
          "countryCode": {
            "type": "string",
            "description": "The country code of the address."
          },
          "district": {
            "type": "string",
            "description": "The district of the address."
          },
          "buildingName": {
            "type": "string",
            "description": "The building name of the address."
          },
          "buildingFloor": {
            "type": "string",
            "description": "The building floor of the address."
          },
          "buildingRoom": {
            "type": "string",
            "description": "The building room of the address."
          },
          "buildingZone": {
            "type": "string",
            "description": "The building zone of the address."
          },
          "crossing1": {
            "type": "string",
            "description": "The first crossing of the address."
          },
          "crossing2": {
            "type": "string",
            "description": "The second crossing of the address."
          }
        }
      },
      "AnonymousUserDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an anonymous user.",
        "properties": {
          "evrythngUser": {
            "type": "string",
            "description": "The Application User ID of this anonymous user.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "status": {
            "type": "string",
            "description": "The status of the user.",
            "enum": [
              "anonymous"
            ],
            "readOnly": true
          },
          "email": {
            "type": "string",
            "description": "The temporary email address assigned to the anonymous user.",
            "readOnly": true
          },
          "evrythngApiKey": {
            "type": "string",
            "description": "The API Key available to the anonymous user.",
            "readOnly": true,
            "pattern": "^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789]{80}$"
          },
          "socialNetwork": {
            "type": "string",
            "description": "The socialNetwork of the anonymous user.",
            "enum": [
              "evrythng"
            ],
            "readOnly": true
          }
        }
      },
      "AppUserStatusField": {
        "type": "string",
        "description": "The activation status of the user.",
        "readOnly": true,
        "enum": [
          "inactive",
          "active"
        ]
      },
      "ApplicationDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing a platform application.",
        "required": [
          "name",
          "socialNetworks"
        ],
        "properties": {
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "socialNetworks": {
            "type": "object",
            "description": "An array of social networks that this application will support.",
            "default": {}
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "project": {
            "type": "string",
            "description": "ID of the platform project this application belongs to.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "defaultUrl": {
            "type": "string",
            "description": "The URL where the default client app for this application is deployed."
          },
          "appApiKey": {
            "type": "string",
            "description": "The API key available to the application.",
            "readOnly": true,
            "pattern": "^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789]{80}$"
          },
          "defaultRole": {
            "type": "string",
            "description": "The default Application User role new Application Users created in this application will be given.",
            "minLength": 13,
            "maxLength": 24
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "project",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "ApplicationRedirectorRuleDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object containing a single Redirector rule set.",
        "required": [
          "redirectUrl"
        ],
        "properties": {
          "match": {
            "type": "string",
            "description": "Filter used to evaluate this rule. Will always match if this field is not set."
          },
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "redirectUrl": {
            "type": "string",
            "description": "URL to redirect to if the rule matches."
          },
          "constants": {
            "type": "object",
            "description": "Key-value pairs (both must be strings). User can add as many as needed."
          }
        }
      },
      "ApplicationRedirectorRulesDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an Application Redirector's rules.",
        "required": [
          "rules"
        ],
        "properties": {
          "rules": {
            "description": "The rules set up for a Redirector.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApplicationRedirectorRuleDocument"
            }
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          }
        }
      },
      "ApplicationUserAccessDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object containing data relevant to an Application User's platform access.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The access ID.",
            "readOnly": true
          },
          "project": {
            "type": "string",
            "description": "The ID of the project the user belongs to.",
            "readOnly": true
          },
          "app": {
            "type": "string",
            "description": "The ID of the application the user belongs to.",
            "readOnly": true
          },
          "user": {
            "type": "string",
            "description": "This user's ID.",
            "readOnly": true
          },
          "actor": {
            "type": "string",
            "description": "The accessing actor's ID.",
            "readOnly": true
          },
          "role": {
            "type": "string",
            "description": "The ID of the user's role.",
            "readOnly": true
          },
          "apiKey": {
            "type": "string",
            "description": "The actor's Application User API Key.",
            "readOnly": true
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          }
        }
      },
      "ApplicationUserActivatedDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing an Application User that has just been activated.",
        "properties": {
          "evrythngUser": {
            "type": "string",
            "description": "The ID of the Application User.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "status": {
            "type": "string",
            "description": "The activation status of the user.",
            "readOnly": true,
            "enum": [
              "active"
            ]
          },
          "evrythngApiKey": {
            "type": "string",
            "description": "The activated user's initial Application User API key.",
            "readOnly": true,
            "pattern": "^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789]{80}$"
          }
        }
      },
      "ApplicationUserActivationDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing an Application User prior to activation.",
        "properties": {
          "evrythngUser": {
            "type": "string",
            "description": "The ID of the Application User.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "activationCode": {
            "type": "string",
            "description": "The code to use to validate the user.",
            "readOnly": true
          },
          "status": {
            "$ref": "#/components/schemas/AppUserStatusField"
          },
          "email": {
            "type": "string",
            "description": "The email address of the new Application User.",
            "readOnly": true
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          }
        }
      },
      "ApplicationUserDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing an Application User.",
        "required": [
          "firstName",
          "lastName",
          "email",
          "password"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "email": {
            "type": "string",
            "description": "E-mail address of the user. Unique within the app."
          },
          "firstName": {
            "type": "string",
            "description": "User's first name."
          },
          "lastName": {
            "type": "string",
            "description": "User's last name."
          },
          "password": {
            "type": "string",
            "description": "The user's password. Must be of 8-64 characters length as well as must contain at least 1 lowercase character, at least 1 uppercase character, at least 1 digit and at least 1 special character.",
            "minLength": 8,
            "maxLength": 64,
            "writeOnly": true
          },
          "birthday": {
            "$ref": "#/components/schemas/BirthdayDocument"
          },
          "gender": {
            "type": "string",
            "description": "User's gender.",
            "enum": [
              "male",
              "female"
            ]
          },
          "timezone": {
            "type": "string",
            "description": "The current timezone for the user. For example: `Pacific/Honolulu` or `Europe/Uzhgorod`)."
          },
          "locale": {
            "type": "string",
            "description": "The default language tag for the user, complied with RFC 5646."
          },
          "photo": {
            "type": "string",
            "description": "URL of the user's photo."
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "project": {
            "type": "string",
            "description": "The project ID of the application this user belongs to.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "app": {
            "type": "string",
            "description": "The ID of the application this user belongs to.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "access": {
            "$ref": "#/components/schemas/ApplicationUserAccessDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "email",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "firstName",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "lastName",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "ApplicationUserLoggedInDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a logged in Application User.",
        "properties": {
          "evrythngUser": {
            "type": "string",
            "description": "The Application User ID of this application user.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "email": {
            "type": "string",
            "description": "The email address assigned to the application user.",
            "readOnly": true
          },
          "evrythngApiKey": {
            "type": "string",
            "description": "The API key available to the application user.",
            "readOnly": true,
            "pattern": "^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789]{80}$"
          },
          "socialNetwork": {
            "type": "string",
            "description": "The socialNetwork of the application user.",
            "readOnly": true
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "status": {
            "$ref": "#/components/schemas/AppUserStatusField"
          }
        }
      },
      "ApplicationUserLoginDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an Application User login request.",
        "required": [
          "email",
          "password"
        ],
        "properties": {
          "email": {
            "type": "string",
            "description": "The email address assigned to the Application User."
          },
          "password": {
            "type": "string",
            "description": "The Application User's password used at account creation time."
          }
        }
      },
      "ApplicationUserLogoutDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an Application User logout response.",
        "properties": {
          "logout": {
            "type": "string",
            "description": "The status of the logout operation.",
            "enum": [
              "ok"
            ],
            "readOnly": true
          }
        }
      },
      "ApplicationUserRoleDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing a Platform role.",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "id": {
            "type": "string",
            "description": "The role ID. May alse be 'none', 'admin', or 'base_app_user' default roles.",
            "readOnly": true,
            "minLength": 4,
            "maxLength": 24
          },
          "type": {
            "type": "string",
            "description": "The type of Role. Only 'userInApp' is currently available.",
            "enum": [
              "userInApp"
            ]
          },
          "version": {
            "type": "integer",
            "description": "The Role API version.",
            "enum": [
              2
            ]
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/RoleScopesDocument"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          }
        }
      },
      "ApplicationUserRolePermissionDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an account role permission. Depending on the type of role, different fields may be returned.",
        "required": [
          "path",
          "access"
        ],
        "properties": {
          "path": {
            "type": "string",
            "description": "The API path the role can access. Must be a subset of the default `base_app_user` permissions."
          },
          "access": {
            "type": "string",
            "description": "A four letter combination of 'c', 'r', 'u', and 'd' describing the access to create, read, update, or destroy the resources in the 'path' of this permission.",
            "minLength": 1,
            "maxLength": 4
          },
          "default": {
            "type": "boolean",
            "description": "`true` for default permissions.",
            "readOnly": true
          }
        }
      },
      "ApplicationUserRolePermissionsDocument": {
        "additionalProperties": false,
        "type": "array",
        "description": "List of Application User role permissions.",
        "items": {
          "$ref": "#/components/schemas/ApplicationUserRolePermissionDocument"
        }
      },
      "ApplicationUserStatusDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing an Application User's status.",
        "properties": {
          "activated": {
            "type": "boolean",
            "description": "Whether or not the Application User is activated."
          },
          "activationDate": {
            "type": "number",
            "description": "Timestamp when the Application User was activated."
          },
          "activationCode": {
            "type": "string",
            "description": "If the Application User is not activated, this is the code required to activate them."
          }
        }
      },
      "AuthThngDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object containing a Device API key and associated Thng ID. Used for both request and response.",
        "properties": {
          "thngId": {
            "type": "string",
            "description": "The Thng ID to create a Device key for.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "thngApiKey": {
            "type": "string",
            "description": "The Device API key.",
            "readOnly": true,
            "pattern": "^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789]{80}$"
          }
        }
      },
      "BasicTaskDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The minimum fields for any of the specific types of task.",
        "required": [
          "type",
          "inputParameters"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "type": {
            "$ref": "#/components/schemas/TaskTypeField"
          },
          "batch": {
            "$ref": "#/components/schemas/BatchField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "status": {
            "$ref": "#/components/schemas/TaskStatusField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "completedAt": {
            "$ref": "#/components/schemas/TaskCompletedAtField"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          },
          "result": {
            "$ref": "#/components/schemas/TaskResultDocument"
          },
          "outputParameters": {
            "$ref": "#/components/schemas/OutputParametersDocument"
          },
          "progress": {
            "$ref": "#/components/schemas/TaskProgressDocument"
          },
          "inputParameters": {
            "type": "object",
            "description": "One of the following types of `inputParameters`: `FixedAmountInputParametersDocument`, `FileBasedInputParametersDocument`, `ListBasedInputParametersDocument`, or `IdentifiersListBasedInputParametersDocument`."
          }
        },
        "x-filterable-fields": [
          {
            "name": "batch",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "status",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "type",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "BatchDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a Platform batch.",
        "required": [
          "name"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "status": {
            "type": "string",
            "description": "The status of the batch.",
            "enum": [
              "EMPTY",
              "IN_PROGRESS",
              "COMPLETE",
              "SEALED"
            ],
            "readOnly": true
          },
          "resourceCountsByProduct": {
            "type": "object",
            "description": "Count of resources, grouped by product ID. Those with no product come under `NO_PRODUCT`.",
            "readOnly": true
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "createdAt",
            "type": "number",
            "operators": [
              ">",
              "<"
            ]
          },
          {
            "name": "identifiers.<key>",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "BatchField": {
        "type": "string",
        "description": "The ID of the batch of this task.",
        "readOnly": true,
        "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
      },
      "BirthdayDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An Application User's birthday.",
        "required": [
          "day",
          "month",
          "year"
        ],
        "properties": {
          "day": {
            "type": "integer",
            "description": "The day of the birthday.",
            "example": 1,
            "minimum": 1,
            "maximum": 31
          },
          "month": {
            "type": "integer",
            "description": "The month of the birthday.",
            "example": 12,
            "minimum": 1,
            "maximum": 12
          },
          "year": {
            "type": "integer",
            "description": "The year of the birthday.",
            "example": 2018,
            "minimum": 1900
          }
        }
      },
      "CollectionDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a Platform collection, which can contain groups of Thngs.",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "type": {
            "$ref": "#/components/schemas/TypeField"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "collections": {
            "description": "An array of collection IDs of any collections this collection belongs to.",
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
            },
            "readOnly": true
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "collections",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "identifiers.<key>",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "CommissionDocument": {
        "type": "object",
        "description": "Object describing a commissioning event.",
        "required": [
          "product",
          "location",
          "occurredAt"
        ],
        "properties": {
          "product": {
            "type": "string",
            "description": "Any valid product identifier separated from its value by ':'.",
            "example": "gs1:01:02374837684278"
          },
          "location": {
            "$ref": "#/components/schemas/LocationDocument"
          },
          "purchaseOrder": {
            "type": "string",
            "description": "Purchase order for which the commission happened"
          },
          "occurredAt": {
            "description": "Date and time of commission in ISO8601 format with time offset",
            "type": "string",
            "format": "date-time"
          },
          "factoryMetadata": {
            "$ref": "#/components/schemas/FactoryMetadataDocument"
          }
        }
      },
      "ContainerContentDocument": {
        "type": "object",
        "description": "A single container line item, describing the product and quantity",
        "required": [
          "quantity",
          "id"
        ],
        "additionalProperties": false,
        "properties": {
          "quantity": {
            "type": "integer",
            "description": "The quantity of product in the container",
            "minimum": 1
          },
          "unitOfMeasure": {
            "type": "string",
            "description": "The unit of measure for the line item such as \"each\"",
            "minLength": 1,
            "maxLength": 128,
            "default": "each"
          },
          "id": {
            "$ref": "#/components/schemas/ProductIdentifierField"
          }
        }
      },
      "ContainerReferenceField": {
        "type": "string",
        "description": "Additional reference to identify the container",
        "minLength": 1,
        "maxLength": 64,
        "pattern": "^[A-Za-z0-9._:+-]+$"
      },
      "ContributionsDocument": {
        "type": "object",
        "description": "Object of keys for each contribution group, with resource counts as the value.",
        "readOnly": true
      },
      "CreatedAtField": {
        "type": "integer",
        "description": "Timestamp when the resource was created.",
        "readOnly": true,
        "minimum": 0
      },
      "CustomFieldsDocument": {
        "type": "object",
        "description": "Object of case-sensititve key-value pairs of custom fields associated with the resource."
      },
      "CustomIdentifierDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object describing the custom identifier values for a single key.",
        "properties": {
          "key": {
            "type": "string",
            "description": "The custom identifier key."
          },
          "values": {
            "type": "array",
            "description": "The array of custom identifier values.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "DatasetCallbackDocument": {
        "required": [
          "secret",
          "state"
        ],
        "type": "object",
        "description": "Callback payload after dataset is downloaded",
        "properties": {
          "secret": {
            "type": "string",
            "description": "Secret key used to authorize calling the callback"
          },
          "state": {
            "type": "string",
            "description": "State of the dataset",
            "enum": [
              "downloaded",
              "running",
              "failed"
            ]
          }
        }
      },
      "DatasetDefinitionDocument": {
        "required": [
          "datasetUrls"
        ],
        "type": "object",
        "description": "Object containing URLs to datasets.",
        "properties": {
          "datasetUrls": {
            "type": "array",
            "description": "One or more URLs describing the training set as URLs of EVRYTHNG resources",
            "items": {
              "type": "string"
            },
            "minLength": 1,
            "maxLength": 65536,
            "example": [
              "https://api.evrythng.com/actions/all?context=true"
            ]
          }
        }
      },
      "DecommissionDocument": {
        "type": "object",
        "description": "Object describing a decommissioning event.",
        "required": [
          "location",
          "occurredAt"
        ],
        "properties": {
          "location": {
            "$ref": "#/components/schemas/LocationDocument"
          },
          "occurredAt": {
            "description": "Date and time of commission in ISO8601 format with time offset",
            "type": "string",
            "format": "date-time"
          },
          "factoryMetadata": {
            "$ref": "#/components/schemas/FactoryMetadataDocument"
          }
        }
      },
      "DefaultRedirectUrlField": {
        "type": "string",
        "description": "The URL for the generated redirections. `{evrythngId}` can substitute the appropriate resource ID."
      },
      "DelegateDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A single app/project delegate.",
        "required": [
          "app",
          "project"
        ],
        "properties": {
          "app": {
            "type": "string",
            "description": "The delegate application ID.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "project": {
            "type": "string",
            "description": "The delegate project ID.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          }
        }
      },
      "DeploymentConfigDocument": {
        "required": [
          "datasets"
        ],
        "type": "object",
        "description": "An object containing a list of datasets.",
        "properties": {
          "datasets": {
            "type": "array",
            "description": "The list of datasets on which the model will be trained.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "DescriptionField": {
        "type": "string",
        "description": "Friendly description of this resource."
      },
      "DomainDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A single account domain entry.",
        "properties": {
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "accountId": {
            "type": "string",
            "description": "The account this domain belongs to.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "domain": {
            "type": "string",
            "description": "The domain URL."
          }
        }
      },
      "ErrorResponseDocument": {
        "type": "object",
        "description": "An HTTP error response object, including error code and reasons.",
        "additionalProperties": false,
        "properties": {
          "status": {
            "type": "number",
            "description": "The error HTTP status code.",
            "example": 404
          },
          "errors": {
            "description": "List of error reasons.",
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "maxItems": 1,
            "example": "The requested resource was not found."
          },
          "code": {
            "description": "Internal error code.",
            "type": "string",
            "example": 348946894
          },
          "moreInfo": {
            "type": "string",
            "description": "Where to find more information.",
            "example": "https://developers.evrythng.com"
          }
        }
      },
      "FacebookAccessDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an access to Facebook.",
        "properties": {
          "socialNetwork": {
            "type": "string",
            "description": "The social network type",
            "enum": [
              "facebook"
            ]
          },
          "access": {
            "$ref": "#/components/schemas/FacebookAccessParametersDocument"
          },
          "socialNetworkId": {
            "type": "string",
            "description": "The ID of the user on Facebook"
          },
          "appId": {
            "type": "string",
            "description": "The ID of the application"
          },
          "evrythngUser": {
            "type": "string",
            "description": "The ID of the App User"
          },
          "evrythngApiKey": {
            "type": "string",
            "description": "The API key of the App User"
          }
        }
      },
      "FacebookAccessParametersDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an access to Facebook.",
        "required": [
          "expires",
          "token"
        ],
        "properties": {
          "expires": {
            "type": "number",
            "description": "Timestamp when the access expires"
          },
          "token": {
            "type": "string",
            "description": "The Facebook access token"
          }
        }
      },
      "FactoryMetadataDocument": {
        "type": "object",
        "description": "Object describing information about the factory.",
        "required": [
          "factory"
        ],
        "properties": {
          "factory": {
            "description": "Identifier of a factory. This value should match \"identifiers.factory\" of the place referenced in \"location.place\" field and match \"customFields.factory\" value of a Thng.",
            "type": "string",
            "example": 123141414
          },
          "supplier": {
            "description": "ID of a supplier",
            "type": "string",
            "example": 574574363
          },
          "zone": {
            "description": "Name of the zone within the factory",
            "type": "string",
            "example": "Line 65"
          }
        }
      },
      "FileBasedInputParametersDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Specification of the task input parameters for the `FILE_BASED` type.",
        "required": [
          "type",
          "generateThngs",
          "generateRedirections",
          "defaultRedirectUrl",
          "thngTemplate",
          "shortDomain",
          "location",
          "format"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/FileBasedInputParametersTypeField"
          },
          "generateThngs": {
            "$ref": "#/components/schemas/GenerateThngsField"
          },
          "generateRedirections": {
            "$ref": "#/components/schemas/GenerateRedirectionsField"
          },
          "defaultRedirectUrl": {
            "$ref": "#/components/schemas/DefaultRedirectUrlField"
          },
          "thngTemplate": {
            "$ref": "#/components/schemas/ThngDocument"
          },
          "shortDomain": {
            "$ref": "#/components/schemas/ShortDomainField"
          },
          "location": {
            "type": "string",
            "description": "The URL of the input file containing the list of short IDs. This must be a Files API uploaded URL."
          },
          "format": {
            "type": "string",
            "description": "The format of the input file referred to by `location`.",
            "enum": [
              "CSV",
              "ZIP"
            ]
          },
          "headers": {
            "type": "object",
            "description": "Key-value object of HTTP headers required when requesting the input file."
          }
        }
      },
      "FileBasedInputParametersTypeField": {
        "type": "string",
        "description": "The FILE_BASED task type.",
        "enum": [
          "FILE_BASED"
        ]
      },
      "FileBasedTaskDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A task for batch creation of Thngs with type `FILE_BASED`.",
        "required": [
          "type",
          "inputParameters"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "type": {
            "$ref": "#/components/schemas/PopulatingTaskTypeField"
          },
          "batch": {
            "$ref": "#/components/schemas/BatchField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "completedAt": {
            "$ref": "#/components/schemas/TaskCompletedAtField"
          },
          "status": {
            "$ref": "#/components/schemas/TaskStatusField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          },
          "result": {
            "$ref": "#/components/schemas/TaskResultDocument"
          },
          "outputParameters": {
            "$ref": "#/components/schemas/OutputParametersDocument"
          },
          "progress": {
            "$ref": "#/components/schemas/TaskProgressDocument"
          },
          "inputParameters": {
            "$ref": "#/components/schemas/FileBasedInputParametersDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "batch",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "status",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "type",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "FileDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object containing remote file metadata.",
        "required": [
          "name",
          "type",
          "privateAccess"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "uploadUrl": {
            "type": "string",
            "description": "The URL to upload file data to with an HTTP `PUT` request. Will expire after 30 mins.",
            "readOnly": true
          },
          "contentUrl": {
            "type": "string",
            "description": "The URL the file is available at for download.",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "Name of the file. This is unique to the account, allowing a file to be overwritten."
          },
          "type": {
            "type": "string",
            "description": "The MIME type of the file. Must match the Content-Type header used when uploading the file content."
          },
          "privateAccess": {
            "type": "boolean",
            "description": "A boolean flag indicating whether a file should have `private` or `public` access on remote storage."
          },
          "size": {
            "type": "integer",
            "description": "The size of the uploaded file in bytes.",
            "readOnly": true
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "FixedAmountInputParametersDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Specification of the task input parameters for the `FIXED_AMOUNT` type.",
        "required": [
          "type",
          "generateThngs",
          "generateRedirections",
          "defaultRedirectUrl",
          "thngTemplate",
          "shortDomain",
          "quantity",
          "shortIdTemplate"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/FixedAmountInputParametersTypeField"
          },
          "generateThngs": {
            "$ref": "#/components/schemas/GenerateThngsField"
          },
          "generateRedirections": {
            "$ref": "#/components/schemas/GenerateRedirectionsField"
          },
          "defaultRedirectUrl": {
            "$ref": "#/components/schemas/DefaultRedirectUrlField"
          },
          "thngTemplate": {
            "$ref": "#/components/schemas/ThngDocument"
          },
          "shortDomain": {
            "$ref": "#/components/schemas/ShortDomainField"
          },
          "quantity": {
            "$ref": "#/components/schemas/QuantityField"
          },
          "shortIdTemplate": {
            "$ref": "#/components/schemas/ShortIdFormatDocument"
          }
        }
      },
      "FixedAmountInputParametersTypeField": {
        "type": "string",
        "description": "The FIXED_AMOUNT task type.",
        "enum": [
          "FIXED_AMOUNT"
        ]
      },
      "FixedAmountTaskDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A task for batch creation of Thngs with type `FIXED_AMOUNT`.",
        "required": [
          "type",
          "inputParameters"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "type": {
            "$ref": "#/components/schemas/PopulatingTaskTypeField"
          },
          "batch": {
            "$ref": "#/components/schemas/BatchField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "completedAt": {
            "$ref": "#/components/schemas/TaskCompletedAtField"
          },
          "status": {
            "$ref": "#/components/schemas/TaskStatusField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          },
          "result": {
            "$ref": "#/components/schemas/TaskResultDocument"
          },
          "outputParameters": {
            "$ref": "#/components/schemas/OutputParametersDocument"
          },
          "progress": {
            "$ref": "#/components/schemas/TaskProgressDocument"
          },
          "inputParameters": {
            "$ref": "#/components/schemas/FixedAmountInputParametersDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "batch",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "status",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "type",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "GenerateRedirectionsField": {
        "type": "boolean",
        "description": "Whether redirections will be created as part of the task."
      },
      "GenerateThngsField": {
        "type": "boolean",
        "description": "Whether Thngs will be created as part of the task."
      },
      "GeoJSONPointDocument": {
        "type": "object",
        "description": "A GeoJSON Point object. The coordinate order is longitude, then latitude.",
        "required": [
          "type",
          "coordinates"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the point.",
            "enum": [
              "Point"
            ]
          },
          "coordinates": {
            "type": "array",
            "description": "The point coordinates",
            "items": {
              "type": "number",
              "minimum": -180,
              "maximum": 180
            }
          }
        }
      },
      "IdField": {
        "type": "string",
        "description": "The ID of this resource.",
        "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
        "readOnly": true
      },
      "IdentifierField": {
        "type": "string",
        "description": "Colon separated identifier with format of 'type:value'",
        "example": "gs1:01:0200010901",
        "minLength": 3,
        "maxLength": 128,
        "pattern": "^[A-Za-z0-9._:-]+:[A-Za-z0-9._-]+$"
      },
      "IdentifiersDocument": {
        "type": "object",
        "description": "Various identifiers (EPC, GTIN, etc.) as a JSON object with one or more key-value pairs."
      },
      "IdentifiersListBasedInputParametersDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Specification of the task input parameters for the `IDENTIFIERS_LIST_BASED` type.",
        "required": [
          "type",
          "generateThngs",
          "generateRedirections",
          "thngTemplate",
          "customIdentifier"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/IdentifiersListBasedInputParametersTypeField"
          },
          "generateThngs": {
            "$ref": "#/components/schemas/GenerateThngsField"
          },
          "generateRedirections": {
            "$ref": "#/components/schemas/GenerateRedirectionsField"
          },
          "thngTemplate": {
            "$ref": "#/components/schemas/ThngDocument"
          },
          "customIdentifier": {
            "$ref": "#/components/schemas/CustomIdentifierDocument"
          }
        }
      },
      "IdentifiersListBasedInputParametersTypeField": {
        "type": "string",
        "description": "The IDENTIFIERS_LIST_BASED task type.",
        "enum": [
          "IDENTIFIERS_LIST_BASED"
        ]
      },
      "IdentifiersListBasedTaskDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A task for batch creation of Thngs with type `IDENTIFIERS_LIST_BASED`.",
        "required": [
          "type",
          "inputParameters"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "type": {
            "$ref": "#/components/schemas/PopulatingTaskTypeField"
          },
          "batch": {
            "$ref": "#/components/schemas/BatchField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "completedAt": {
            "$ref": "#/components/schemas/TaskCompletedAtField"
          },
          "status": {
            "$ref": "#/components/schemas/TaskStatusField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          },
          "result": {
            "$ref": "#/components/schemas/TaskResultDocument"
          },
          "outputParameters": {
            "$ref": "#/components/schemas/OutputParametersDocument"
          },
          "progress": {
            "$ref": "#/components/schemas/TaskProgressDocument"
          },
          "inputParameters": {
            "$ref": "#/components/schemas/IdentifiersListBasedInputParametersDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "batch",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "status",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "type",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "KeyAccessDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object describing the account and actor associated with a key",
        "properties": {
          "account": {
            "type": "string",
            "description": "Account ID for this key",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "actor": {
            "$ref": "#/components/schemas/ActorDocument"
          }
        }
      },
      "LatitudeField": {
        "type": "number",
        "description": "The latitude."
      },
      "LineItemDocument": {
        "description": "A purchase order Line Item.",
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "quantity",
          "product",
          "exportDate",
          "deliveryDate"
        ],
        "properties": {
          "id": {
            "description": "The purchase order Line number.",
            "type": "string",
            "example": "00010",
            "minLength": 2,
            "maxLength": 64
          },
          "quantity": {
            "description": "The quantity of products to be manufactured.",
            "type": "number",
            "example": 100,
            "minimum": 1
          },
          "unitOfMeasure": {
            "description": "The unit of measure for the line item such as \"each\".",
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "default": "each"
          },
          "product": {
            "description": "A colon separated identifier string referencing an EVRYTHNG product.",
            "type": "string",
            "example": "gs1:01:00000123456789",
            "minLength": 3,
            "maxLength": 128
          },
          "exportDate": {
            "description": "The date the line item is expected to be exported on, in YYYY-MM-DD format.",
            "type": "string",
            "example": "2019-02-14",
            "format": "date"
          },
          "deliveryDate": {
            "description": "The date the line item is expected to be delivered on, in YYYY-MM-DD format.",
            "type": "string",
            "example": "2019-02-18",
            "format": "date"
          }
        }
      },
      "ListBasedInputParametersDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Specification of the task input parameters for the `LIST_BASED` type.",
        "required": [
          "type",
          "generateThngs",
          "generateRedirections",
          "defaultRedirectUrl",
          "thngTemplate",
          "shortDomain",
          "inputData"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/ListBasedInputParametersTypeField"
          },
          "generateThngs": {
            "$ref": "#/components/schemas/GenerateThngsField"
          },
          "generateRedirections": {
            "$ref": "#/components/schemas/GenerateRedirectionsField"
          },
          "defaultRedirectUrl": {
            "$ref": "#/components/schemas/DefaultRedirectUrlField"
          },
          "thngTemplate": {
            "$ref": "#/components/schemas/ThngDocument"
          },
          "shortDomain": {
            "$ref": "#/components/schemas/ShortDomainField"
          },
          "inputData": {
            "type": "array",
            "description": "List of objects detailing the short IDs to use",
            "items": {
              "$ref": "#/components/schemas/RedirectionResourceDocument"
            },
            "example": [
              {
                "shortId": "serial1"
              },
              {
                "shortId": "serial2"
              },
              {
                "shortId": "serial3"
              }
            ]
          }
        }
      },
      "ListBasedInputParametersTypeField": {
        "type": "string",
        "description": "The LIST_BASED task type.",
        "enum": [
          "LIST_BASED"
        ]
      },
      "ListBasedTaskDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A task for batch creation of Thngs with type `LIST_BASED`.",
        "required": [
          "type",
          "inputParameters"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "type": {
            "$ref": "#/components/schemas/PopulatingTaskTypeField"
          },
          "batch": {
            "$ref": "#/components/schemas/BatchField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "completedAt": {
            "$ref": "#/components/schemas/TaskCompletedAtField"
          },
          "status": {
            "$ref": "#/components/schemas/TaskStatusField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          },
          "result": {
            "$ref": "#/components/schemas/TaskResultDocument"
          },
          "outputParameters": {
            "$ref": "#/components/schemas/OutputParametersDocument"
          },
          "progress": {
            "$ref": "#/components/schemas/TaskProgressDocument"
          },
          "inputParameters": {
            "$ref": "#/components/schemas/ListBasedInputParametersDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "batch",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "status",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "type",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "LocationDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a location. Either 'position' or 'place' us required.",
        "properties": {
          "position": {
            "$ref": "#/components/schemas/GeoJSONPointDocument"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "timestamp": {
            "type": "integer",
            "description": "The time the location update occurred, or filled automatically by the Platform if omitted.",
            "readOnly": true
          },
          "longitude": {
            "$ref": "#/components/schemas/LongitudeField"
          },
          "latitude": {
            "$ref": "#/components/schemas/LatitudeField"
          },
          "place": {
            "type": "string",
            "description": "The place ID.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "timestamp",
            "type": "number",
            "operators": [
              "<",
              ">"
            ]
          }
        ]
      },
      "LongitudeField": {
        "type": "number",
        "description": "The longitude."
      },
      "MeDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing the payload of the \"/me\" API",
        "readOnly": true,
        "required": [
          "name",
          "email",
          "conditions",
          "policies"
        ],
        "properties": {
          "name": {
            "description": "The name of the operator.",
            "type": "string",
            "example": "Firstname Lastname",
            "minLength": 5,
            "maxLength": 128
          },
          "email": {
            "type": "string",
            "description": "The operator email address.",
            "example": "email@domain.com"
          },
          "description": {
            "description": "The description of the operator access.",
            "type": "string",
            "maxLength": 256
          },
          "operator": {
            "description": "The operator ID",
            "type": "string"
          },
          "policies": {
            "description": "An array of policies",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AccessPolicyDocument"
            }
          },
          "conditions": {
            "description": "A conditions array.",
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 3,
              "maxLength": 128,
              "pattern": "^[A-Za-z0-9_-]+:[A-Za-z0-9_-]+$"
            },
            "maxItems": 256,
            "uniqueItems": true
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          }
        }
      },
      "ModelTypePayloadDocument": {
        "required": [
          "name"
        ],
        "type": "object",
        "description": "Object containing the name of the model type.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the new type of model."
          }
        }
      },
      "NameField": {
        "type": "string",
        "description": "Friendly name of this resource."
      },
      "NestModelDevicesDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The device structures for Nest thermostats, smoke alarms, and cameras.",
        "properties": {
          "thermostats": {
            "$ref": "#/components/schemas/ThngDocument"
          },
          "smoke_co_alarms": {
            "$ref": "#/components/schemas/ThngDocument"
          },
          "cameras": {
            "$ref": "#/components/schemas/ThngDocument"
          }
        }
      },
      "NestModelDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object representing the device connector model with the Nest API.",
        "properties": {
          "structures": {
            "$ref": "#/components/schemas/ThngDocument"
          },
          "devices": {
            "$ref": "#/components/schemas/NestModelDevicesDocument"
          }
        }
      },
      "OAuthClientDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an OAuth client.",
        "required": [
          "name",
          "redirectUrl"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the OAuth client.",
            "minLength": 45,
            "maxLength": 45,
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "The name of the OAuth client."
          },
          "redirectUrl": {
            "type": "string",
            "description": "The OAuth redirect URL. Must be a valid absolute URL under HTTPS protocol."
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          }
        }
      },
      "OAuthDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "OAuth connector credentials",
        "required": [
          "clientId",
          "clientSecret"
        ],
        "properties": {
          "clientId": {
            "type": "string",
            "description": "The OAuth client ID for the 3rd party service.",
            "minLength": 36,
            "maxLength": 36
          },
          "clientSecret": {
            "type": "string",
            "description": "The OAuth client secret for the 3rd party service.",
            "minLength": 25,
            "maxLength": 25
          },
          "type": {
            "type": "string",
            "description": "The authentication type.",
            "enum": [
              "oauth"
            ]
          },
          "oAuthUrl": {
            "type": "string",
            "description": "The URL of the OAuth service."
          },
          "tokenUrl": {
            "type": "string",
            "description": "The URL of the OAuth service access token."
          }
        }
      },
      "OperatorAccessDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing an operator access.",
        "readOnly": true,
        "required": [
          "name",
          "email",
          "conditions",
          "policies"
        ],
        "properties": {
          "name": {
            "description": "The name of the operator.",
            "type": "string",
            "example": "Firstname Lastname",
            "minLength": 5,
            "maxLength": 128
          },
          "email": {
            "type": "string",
            "description": "The operator email address.",
            "example": "email@domain.com",
            "readOnly": true
          },
          "description": {
            "description": "The description of the operator access.",
            "type": "string",
            "maxLength": 256
          },
          "operator": {
            "description": "The operator ID",
            "type": "string"
          },
          "policies": {
            "description": "An array of policy IDs",
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 24,
              "maxLength": 24
            },
            "uniqueItems": true,
            "maxItems": 100
          },
          "conditions": {
            "description": "A conditions array.",
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 3,
              "maxLength": 128,
              "pattern": "^[A-Za-z0-9_-]+:[A-Za-z0-9_-]+$"
            },
            "maxItems": 256,
            "uniqueItems": true
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "email",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "policies",
            "type": "list of string",
            "operators": [
              "="
            ]
          },
          {
            "name": "conditions",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "OperatorRoleDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object representing an Operator role.",
        "required": [
          "name"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          }
        }
      },
      "OperatorRolePermissionDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object describing Operator role permissions",
        "required": [
          "name",
          "enabled"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the specific role permission.",
            "enum": [
              "global_read",
              "gl_resource_update",
              "gl_project_update",
              "project_read",
              "project_update",
              "project_resource_update"
            ]
          },
          "enabled": {
            "type": "boolean",
            "description": "`true` if this permission is enabled, `false` otherwise."
          },
          "projectScoped": {
            "type": "boolean",
            "description": "`true` if this permission if enabled only for specific project(s), `false` otherwise.",
            "readOnly": true
          },
          "projects": {
            "type": "array",
            "description": "Array of project IDs that this permission is enabled for.",
            "items": {
              "type": "string",
              "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
            }
          },
          "children": {
            "$ref": "#/components/schemas/OperatorRolePermissionDocument"
          }
        }
      },
      "OutputParametersDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The output format for the task.",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "The output format type.",
            "enum": [
              "CSV"
            ]
          },
          "columns": {
            "type": "array",
            "description": "The CSV columns to use. Valid values are 'SHORT_ID' and 'THNG'.",
            "items": {
              "type": "string",
              "enum": [
                "SHORT_ID",
                "THNG"
              ]
            }
          }
        }
      },
      "OutputParametersFormatField": {
        "type": "string",
        "description": "The type of input or results file.",
        "enum": [
          "CSV",
          "ZIP"
        ]
      },
      "PlaceDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing a real physical place with an address.",
        "properties": {
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "type": {
            "$ref": "#/components/schemas/TypeField"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "position": {
            "$ref": "#/components/schemas/GeoJSONPointDocument"
          },
          "icon": {
            "type": "string",
            "description": "URL to an image representing the place."
          },
          "address": {
            "$ref": "#/components/schemas/AddressDocument"
          },
          "longitude": {
            "$ref": "#/components/schemas/LongitudeField"
          },
          "latitude": {
            "$ref": "#/components/schemas/LatitudeField"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "identifiers.<key>",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "PopulatingTaskTypeField": {
        "type": "string",
        "description": "The type of task to perform.",
        "enum": [
          "POPULATING"
        ]
      },
      "PredictionPayloadDocument": {
        "required": [
          "data"
        ],
        "type": "object",
        "description": "Object containing the prediction data items.",
        "properties": {
          "data": {
            "type": "array",
            "description": "Input on which the model should generate a prediction.",
            "items": {
              "$ref": "#/components/schemas/UnknownDocument"
            }
          }
        }
      },
      "ProductDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a platform product. Product can have identifiers. Identifiers\nwhich have keys mentioned in account unique identifiers configuration will be concatenated and\nused as unique identifier for a given product which means that user will not be able to create\ntwo products with the same unique identifiers.",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "activatedAt": {
            "type": "integer",
            "description": "Timestamp when the product was activated.",
            "readOnly": true
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "type": {
            "$ref": "#/components/schemas/TypeField"
          },
          "categories": {
            "description": "An array of product categories as strings.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "photos": {
            "description": "An array of product photo URLs as strings.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "url": {
            "type": "string",
            "description": "The URL linking to the product information."
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "properties": {
            "type": "object",
            "description": "A JSON object with key-value pairs describing properties of the product."
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "fn": {
            "type": "string",
            "description": "Friendly name of the product.",
            "readOnly": true
          },
          "brand": {
            "type": "string",
            "description": "The product's brand name."
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "identifiers.<key>",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "ProductIdentifierField": {
        "type": "string",
        "description": "The product identifier. Colon separated identifier with format of 'type:value'",
        "example": "gs1:01:0200010901",
        "minLength": 3,
        "maxLength": 128,
        "pattern": "^[A-Za-z0-9._:-]+:[A-Za-z0-9._-]+$"
      },
      "ProjectDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing a platform project.",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "startsAt": {
            "type": "integer",
            "description": "Timestamp when this project starts."
          },
          "endsAt": {
            "type": "integer",
            "description": "Timestamp when this project ends."
          },
          "imageUrl": {
            "type": "string",
            "description": "URL link to the image to use in the project properties view."
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "shortDomains": {
            "type": "array",
            "description": "An array of short domains assigned for the project, for example: `tn.gg` by default.",
            "items": {
              "type": "string"
            }
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "identifiers.<key>",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "PropertiesDocument": {
        "additionalProperties": false,
        "type": "array",
        "description": "An object representing multiple properties.",
        "items": {
          "$ref": "#/components/schemas/PropertyDocument"
        }
      },
      "PropertyDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a single property update. The `value` property may be a string or integer.",
        "required": [
          "key",
          "value"
        ],
        "properties": {
          "key": {
            "type": "string",
            "description": "The property key-value key.",
            "example": "temperature_celsius"
          },
          "value": {
            "description": "The property key-value value.",
            "example": 32
          },
          "timestamp": {
            "type": "integer",
            "description": "The timestamp of the property update.",
            "readOnly": true,
            "minimum": 0,
            "example": 1566209345528
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          }
        },
        "x-filterable-fields": [
          {
            "name": "timestamp",
            "type": "number",
            "operators": [
              "<",
              ">"
            ]
          }
        ]
      },
      "PurchaseOrderDocument": {
        "description": "An object representing a purchase order.",
        "type": "object",
        "required": [
          "id",
          "status",
          "type",
          "issueDate",
          "parties",
          "lines"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The purchase order ID."
          },
          "evrythngId": {
            "type": "string",
            "description": "Standard 24 character EVRYTHNG ID of this purchase order.",
            "readOnly": true
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "version": {
            "description": "The latest version of the purchase order.",
            "type": "string",
            "example": "1",
            "minLength": 1,
            "maxLength": 32
          },
          "status": {
            "description": "The status of the purchase order, such as 'open' or 'cancelled'.",
            "type": "string",
            "example": "open",
            "minLength": 2,
            "maxLength": 256
          },
          "purchaser": {
            "description": "The name of the purchasing party.",
            "type": "string",
            "minLength": 2,
            "maxLength": 32
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "type": {
            "description": "The type of purchase order determines how the manufacturer interprets the Order, such as 'stand-alone', 'reorder', 'direct-ship'.",
            "type": "string",
            "example": "stand-alone",
            "minLength": 2,
            "maxLength": 32
          },
          "issueDate": {
            "description": "The date the purchase order was issued, in YYYY-MM-DD format.",
            "type": "string",
            "example": "2019-02-10",
            "format": "date"
          },
          "parties": {
            "description": "The parties involved in the purchase order. Must contain one item for each of 'ship-from', 'ship-to', and 'supplier'.",
            "type": "array",
            "example": [
              {
                "id": "gs1:414:943234",
                "type": "supplier"
              },
              {
                "id": "gs1:414:01251",
                "type": "ship-from"
              },
              {
                "id": "gs1:414:NA0193",
                "type": "ship-to"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/PurchaseOrderPartyDocument"
            },
            "minItems": 2,
            "maxItems": 13
          },
          "lines": {
            "description": "Line Items outlining the products, quantities and dates included in the purchase order.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LineItemDocument"
            },
            "minItems": 1,
            "maxItems": 1000
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "createdAt",
            "type": "number",
            "operators": [
              "=",
              ">",
              "<"
            ]
          },
          {
            "name": "shipFrom",
            "type": "list of string",
            "operators": [
              "="
            ]
          },
          {
            "name": "status",
            "type": "list of string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          },
          {
            "name": "type",
            "type": "list of string",
            "operators": [
              "="
            ]
          },
          {
            "name": "updatedAt",
            "type": "number",
            "operators": [
              "=",
              ">",
              "<"
            ]
          }
        ]
      },
      "PurchaseOrderPartyDocument": {
        "description": "A party involved in the purchase order.",
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "type"
        ],
        "properties": {
          "id": {
            "description": "Colon separated identifer, referencing a place.",
            "type": "string",
            "example": "gs1:414:01251",
            "minLength": 2,
            "maxLength": 64
          },
          "type": {
            "description": "The role the party has in the purchase order, such as 'ship-from', 'ship-to', 'supplier', 'mark-for'.",
            "type": "string",
            "enum": [
              "ship-from",
              "ship-to",
              "supplier",
              "mark-for"
            ],
            "example": "ship-from"
          }
        }
      },
      "QuantityField": {
        "type": "integer",
        "description": "The number of resources."
      },
      "RateLimitLimitDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The rate limit limits.",
        "properties": {
          "rate": {
            "type": "string",
            "description": "The rate limit rate type."
          },
          "timeFrame": {
            "type": "number",
            "description": "The time frame of the rate limit."
          },
          "warningMaxHits": {
            "type": "number",
            "description": "The warning maximum hits."
          },
          "blockingMaxHits": {
            "type": "number",
            "description": "The blocking maximum hits."
          }
        }
      },
      "RateLimitsDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object containing API key rate limit information.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the rate limit type."
          },
          "rateLimits": {
            "type": "array",
            "description": "Array of applicable rate limit information",
            "items": {
              "$ref": "#/components/schemas/SingleRateLimitDocument"
            }
          }
        }
      },
      "RateLimitsUrlDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Information on rate limit URL",
        "properties": {
          "path": {
            "type": "string",
            "description": "The rate limit path"
          },
          "depth": {
            "type": "number",
            "description": "The rate limit path URL depth"
          }
        }
      },
      "ReactionDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A single reaction from Redirector.",
        "properties": {
          "type": {
            "type": "string",
            "description": "The reaction type.",
            "enum": [
              "redirection"
            ],
            "readOnly": true
          },
          "redirectUrl": {
            "type": "string",
            "description": "The redirection URL.",
            "readOnly": true
          },
          "redirectionContext": {
            "type": "object",
            "description": "Object of redirection context values.",
            "readOnly": true
          }
        }
      },
      "ReactorActionCreatedDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The event parameter passed to an `onActionCreated` event callback.",
        "properties": {
          "action": {
            "$ref": "#/components/schemas/ActionDocument"
          },
          "triggerApp": {
            "$ref": "#/components/schemas/TriggerAppField"
          },
          "triggerUser": {
            "$ref": "#/components/schemas/TriggerUserField"
          },
          "triggerUserAnonymous": {
            "$ref": "#/components/schemas/TriggerUserAnonymousField"
          }
        }
      },
      "ReactorLogEntryDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A Reactor log entry.",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "app": {
            "type": "string",
            "description": "The ID of the application.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "logLevel": {
            "type": "string",
            "description": "The level of the log message.",
            "enum": [
              "trace",
              "debug",
              "info",
              "warn",
              "error"
            ],
            "readOnly": true
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "timestamp": {
            "type": "integer",
            "description": "When the log entry appeared",
            "readOnly": true
          },
          "message": {
            "type": "string",
            "description": "The content of the log entry.",
            "readOnly": true
          }
        },
        "x-filterable-fields": [
          {
            "name": "app",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "logLevel",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "timestamp",
            "type": "number",
            "operators": [
              "<",
              ">"
            ]
          }
        ]
      },
      "ReactorProductPropertiesChangedDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The event parameter passed to an `onProductPropertiesChanged` event callback.",
        "properties": {
          "product": {
            "$ref": "#/components/schemas/ProductDocument"
          },
          "changes": {
            "type": "object",
            "description": "Object containing a key for each changed property, with value of a `ReactorPropertyChangeDocument`."
          },
          "triggerApp": {
            "$ref": "#/components/schemas/TriggerAppField"
          },
          "triggerUser": {
            "$ref": "#/components/schemas/TriggerUserField"
          },
          "triggerUserAnonymous": {
            "$ref": "#/components/schemas/TriggerUserAnonymousField"
          }
        }
      },
      "ReactorPropertyChangeDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object describing the property changes for this event.",
        "properties": {
          "oldValue": {
            "description": "The previous property value."
          },
          "newValue": {
            "description": "The new property value"
          },
          "timestamp": {
            "type": "integer",
            "description": "The time that the update occured.",
            "minimum": 1508761430000
          }
        }
      },
      "ReactorScheduleDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object describing a Reactor schedule. Either 'cron' or 'executeAt' is required.",
        "required": [
          "event"
        ],
        "properties": {
          "event": {
            "type": "object",
            "description": "Object to be passed as the parameter to the callback when it is invoked."
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "function": {
            "type": "string",
            "description": "The name of the exported function to invoke."
          },
          "executeAt": {
            "type": "integer",
            "description": "Unix timestamp (milliseconds) describing when to execute the scheduled event.",
            "minimum": 0
          },
          "cron": {
            "type": "string",
            "description": "Cron expression describing the execution interval."
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "enabled": {
            "type": "boolean",
            "description": "If the schedule is enabled. Defaults to `true`."
          }
        }
      },
      "ReactorScheduledEventDocument": {
        "type": "object",
        "description": "Object as defined in the `ReactorScheduleDocument.event` field."
      },
      "ReactorScriptDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object containing a Reactor script and associated metadata.",
        "required": [
          "script"
        ],
        "properties": {
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "type": {
            "type": "string",
            "description": "The type of Reactor script.",
            "enum": [
              "simple",
              "bundle"
            ],
            "readOnly": true
          },
          "script": {
            "type": "string",
            "description": "The Reactor script body."
          },
          "manifest": {
            "type": "string",
            "description": "The Reactor script manifest, in a format similar to Node's `package.json`."
          }
        }
      },
      "ReactorScriptStatusDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object describing the status of the Reactor script.",
        "properties": {
          "updating": {
            "type": "boolean",
            "description": "If the Reactor script is updating at the moment.",
            "readOnly": true
          },
          "error": {
            "type": "string",
            "description": "Error message if failed to update the Reactor script.",
            "readOnly": true
          }
        }
      },
      "ReactorThngPropertiesChangedDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The event parameter passed to an `onThngPropertiesChanged` event callback.",
        "properties": {
          "thng": {
            "$ref": "#/components/schemas/ThngDocument"
          },
          "changes": {
            "type": "object",
            "description": "Object containing a key for each changed property, with value of a `ReactorPropertyChangeDocument`."
          },
          "triggerApp": {
            "$ref": "#/components/schemas/TriggerAppField"
          },
          "triggerUser": {
            "$ref": "#/components/schemas/TriggerUserField"
          },
          "triggerUserAnonymous": {
            "$ref": "#/components/schemas/TriggerUserAnonymousField"
          }
        }
      },
      "RedirectionDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A redirection on a resource.",
        "required": [
          "defaultRedirectUrl"
        ],
        "properties": {
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "defaultRedirectUrl": {
            "type": "string",
            "description": "The location to redirect to."
          },
          "redirectUrl": {
            "type": "string",
            "description": "The redirect URL."
          },
          "evrythngUrl": {
            "type": "string",
            "description": "The location of the EVRYTHNG resource.",
            "readOnly": true
          },
          "evrythngId": {
            "type": "string",
            "description": "The EVRYTHNG ID of the associated resource.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
            "readOnly": true
          },
          "shortDomain": {
            "type": "string",
            "description": "The associated short domain for the redirection.",
            "readOnly": true
          },
          "shortId": {
            "type": "string",
            "description": "The short ID of the redirection",
            "minLength": 8,
            "maxLength": 10,
            "readOnly": true
          },
          "type": {
            "type": "string",
            "description": "The type of the associated EVRYTHNG resource.",
            "enum": [
              "thng",
              "product",
              "collection",
              "place"
            ],
            "readOnly": true
          },
          "hits": {
            "type": "integer",
            "description": "The number of times the redirection has been hit.",
            "readOnly": true
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        }
      },
      "RedirectionResourceDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Container for a task generation short ID.",
        "properties": {
          "shortId": {
            "type": "string",
            "description": "The short ID for the redirection."
          }
        }
      },
      "ReferenceField": {
        "type": "string",
        "description": "Original reference identifier",
        "minLength": 1,
        "maxLength": 64,
        "pattern": "^[A-Za-z0-9._:+-]+$"
      },
      "ReferenceImageDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object representing an image recognition reference image.",
        "required": [
          "name"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "name": {
            "type": "string",
            "description": "Long name of the image resource."
          },
          "thumb60": {
            "type": "string",
            "description": "Location of the 60px thumbnail."
          },
          "thumb120": {
            "type": "string",
            "description": "Location of the 120px thumbnail."
          },
          "file": {
            "type": "string",
            "description": "Location of the file."
          }
        }
      },
      "RoleScopesDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The roles and projects scopes this role is scoped to.",
        "required": [
          "roles",
          "projects"
        ],
        "properties": {
          "roles": {
            "type": "array",
            "description": "The roles this role is scoped to.",
            "items": {
              "$ref": "#/components/schemas/IdField"
            }
          },
          "projects": {
            "type": "array",
            "description": "The projects this role is scoped to.",
            "items": {
              "$ref": "#/components/schemas/IdField"
            }
          }
        }
      },
      "ScanImageContentDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object containing image data in Base 64 encoding.",
        "required": [
          "image"
        ],
        "properties": {
          "image": {
            "type": "string",
            "description": "Base 64 encoded image data"
          }
        }
      },
      "ScanImageMetadataDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Metadata about the scan.",
        "properties": {
          "method": {
            "type": "string",
            "description": "The scan method",
            "enum": [
              "ocr",
              "ir",
              "1d",
              "2d"
            ],
            "readOnly": true
          },
          "score": {
            "type": "integer",
            "description": "The scanning score.",
            "readOnly": true
          },
          "type": {
            "type": "string",
            "description": "The scanning code type.",
            "enum": [
              "text",
              "image",
              "codabar",
              "code_11",
              "code_39",
              "code_93",
              "code_128",
              "ean_8",
              "ean_13",
              "industr_25",
              "itf",
              "rss_14",
              "rss_expanded",
              "rss_limited",
              "upc_a",
              "upc_e",
              "dm",
              "qr_code"
            ],
            "readOnly": true
          },
          "value": {
            "type": "string",
            "description": "The encoded value.",
            "readOnly": true
          }
        }
      },
      "ScanImageResultDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A single image scan result.",
        "properties": {
          "product": {
            "$ref": "#/components/schemas/ProductDocument"
          },
          "thng": {
            "$ref": "#/components/schemas/ThngDocument"
          },
          "redirections": {
            "type": "array",
            "description": "Array of redirections for the resource",
            "items": {
              "type": "string"
            },
            "readOnly": true
          }
        }
      },
      "ScanImageResultsDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object containing the results of an image scan with the Identifier Recognition API.",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/ScanImageMetadataDocument"
          },
          "results": {
            "type": "array",
            "description": "Array of individual results",
            "items": {
              "$ref": "#/components/schemas/ScanImageResultDocument"
            }
          }
        }
      },
      "ScopesDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Project and user scopes arrays.",
        "required": [
          "users",
          "projects"
        ],
        "properties": {
          "users": {
            "type": "array",
            "description": "An array of Application User IDs this resource is scoped to.",
            "items": {
              "type": "string"
            }
          },
          "projects": {
            "type": "array",
            "description": "An array of project IDs this resource is scoped to.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "SecretKeyDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object containing an application's Secret Key",
        "properties": {
          "secretApiKey": {
            "type": "string",
            "description": "The Trusted Application API Key"
          }
        }
      },
      "ShipmentNoticeContentDocument": {
        "description": "A product included in this shipment notice.",
        "type": "object",
        "additionalProperties": false,
        "required": [
          "product",
          "quantity"
        ],
        "properties": {
          "product": {
            "$ref": "#/components/schemas/ProductIdentifierField"
          },
          "quantity": {
            "type": "integer",
            "description": "The quantity of this product included in this shipment.",
            "minimum": 1,
            "maximum": 9999999,
            "example": 250
          }
        }
      },
      "ShipmentNoticeDocument": {
        "description": "An object representing a shipment notice.",
        "type": "object",
        "required": [
          "asnId",
          "status",
          "issueDate",
          "parties"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "asnId": {
            "type": "string",
            "description": "ID of the associated shipment notice.",
            "minLength": 1,
            "maxLength": 64,
            "pattern": "^[A-Za-z0-9._:+-]+$",
            "example": "9827429837429823828273"
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "version": {
            "description": "Identifies the current version of the shipment, the default value is '1'",
            "type": "string",
            "minLength": 1,
            "maxLength": 32,
            "default": 1,
            "example": "1"
          },
          "status": {
            "type": "string",
            "description": "The status of the shipment",
            "enum": [
              "open",
              "closed",
              "cancelled"
            ],
            "default": "open",
            "example": "open"
          },
          "purchaseOrderId": {
            "description": "A reference to an associated purchase order",
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9:_+.@-]+$",
            "example": "4700990774"
          },
          "issueDate": {
            "description": "The date the shipment was issued on",
            "type": "string",
            "format": "date-time",
            "example": "2016-12-19T16:39:57-08:00"
          },
          "deliveryDate": {
            "description": "The date the shipment is due to be delivered",
            "type": "string",
            "format": "date-time",
            "example": "2013-04-12T23:20:50.52Z"
          },
          "transportation": {
            "type": "string",
            "description": "The type of transportation",
            "minLength": 1,
            "maxLength": 32,
            "example": "Air"
          },
          "parties": {
            "type": "array",
            "description": "The parties involved in the shipment",
            "minItems": 2,
            "maxItems": 3,
            "items": {
              "$ref": "#/components/schemas/ShipmentNoticePartyDocument"
            },
            "example": [
              {
                "id": "gs1:414:01251",
                "type": "ship-from"
              },
              {
                "name": "The Landmark, Shop No. G14",
                "type": "ship-to",
                "address": {
                  "street": "113-114, Central",
                  "city": "Hong Kong"
                }
              }
            ]
          },
          "contents": {
            "type": "array",
            "description": "Array of products in the shipment and their quantites.",
            "items": {
              "$ref": "#/components/schemas/ShipmentNoticeContentDocument"
            },
            "minItems": 1,
            "maxItems": 1000,
            "example": [
              {
                "product": "gs1:01:00001254563898",
                "quantity": 250
              },
              {
                "product": "gs1:01:00283679123844",
                "quantity": 42
              }
            ]
          }
        },
        "x-filterable-fields": [
          {
            "name": "purchaseOrderId",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          },
          {
            "name": "status",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "ShipmentNoticePartyDocument": {
        "description": "A party involved in this shipment notice.",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdentifierField"
          },
          "name": {
            "type": "string",
            "description": "Display name for the party",
            "minLength": 2,
            "maxLength": 128
          },
          "type": {
            "type": "string",
            "description": "The party type defines what involvement the identified party has in this shipment notice",
            "enum": [
              "ship-from",
              "ship-to",
              "bill-to"
            ],
            "example": "ship-from"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "address": {
            "$ref": "#/components/schemas/AddressDocument"
          }
        }
      },
      "ShortDomainField": {
        "type": "string",
        "description": "The short domain used for generated redirections."
      },
      "ShortIdFormatDocument": {
        "type": "object",
        "description": "The template of the short ID format. Contains one field 'type' with only one permitted value 'THNG_ID'.",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of template. Can only be 'THNG_ID'",
            "enum": [
              "THNG_ID"
            ]
          }
        }
      },
      "ShortIdGenerationInputParametersDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Input parameters for a Short ID Generation Task.",
        "required": [
          "quantity",
          "shortIdTemplate"
        ],
        "properties": {
          "quantity": {
            "type": "integer",
            "description": "Amount of short IDs to generate."
          },
          "shortIdTemplate": {
            "$ref": "#/components/schemas/ShortIdTemplateDocument"
          }
        }
      },
      "ShortIdGenerationTaskDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A task for batch creation of short IDs.",
        "required": [
          "type",
          "inputParameters"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "type": {
            "$ref": "#/components/schemas/ShortIdGenerationTaskTypeField"
          },
          "batch": {
            "$ref": "#/components/schemas/BatchField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "completedAt": {
            "$ref": "#/components/schemas/TaskCompletedAtField"
          },
          "status": {
            "$ref": "#/components/schemas/TaskStatusField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          },
          "result": {
            "$ref": "#/components/schemas/TaskResultDocument"
          },
          "inputParameters": {
            "$ref": "#/components/schemas/ShortIdGenerationInputParametersDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "batch",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "status",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "type",
            "type": "string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "ShortIdGenerationTaskTypeField": {
        "type": "string",
        "description": "The type of task to perform.",
        "enum": [
          "SHORT_ID_GENERATION"
        ]
      },
      "ShortIdTemplateDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a short ID generation task on a batch.",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of ShortIdTemplateDocument.",
            "enum": [
              "SEQUENTIAL",
              "PSEUDO_RANDOM"
            ]
          },
          "length": {
            "type": "integer",
            "description": "Full length of the short ID. Including separators, prefix, and suffix."
          },
          "start": {
            "type": "integer",
            "description": "Value of the core of the first code generated."
          },
          "increment": {
            "type": "integer",
            "description": "Increment of the core for subsequent codes generated."
          },
          "padding": {
            "type": "string",
            "description": "How to pad the sequence, in order to keep a fixed length.",
            "enum": [
              "ZERO",
              "CHAR"
            ]
          },
          "paddingChar": {
            "type": "string",
            "description": "Single character used to pad, if `padding` is `CHAR`."
          },
          "prefix": {
            "type": "string",
            "description": "Prefix in the short ID pattern."
          },
          "suffix": {
            "type": "string",
            "description": "Suffix in the short ID pattern."
          },
          "separator": {
            "type": "string",
            "description": "Separator between prefix and core, and core and suffix in the short ID pattern."
          }
        }
      },
      "SingleRateLimitDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A single set of rate limit information",
        "properties": {
          "url": {
            "$ref": "#/components/schemas/RateLimitsUrlDocument"
          },
          "access": {
            "type": "string",
            "description": "The rate limit access type."
          },
          "limit": {
            "$ref": "#/components/schemas/RateLimitLimitDocument"
          },
          "hits": {
            "type": "number",
            "description": "The number of hits so far since reset."
          },
          "hitsRemaining": {
            "type": "number",
            "description": "The remaining number of hits until reset."
          },
          "reset": {
            "type": "number",
            "description": "Number of seconds until rate limit reset."
          }
        }
      },
      "StateDocument": {
        "type": "object",
        "description": "Object containing the commissioning state.",
        "properties": {
          "state": {
            "type": "string",
            "description": "Commissioning state of a Thng.",
            "enum": [
              "commissioned",
              "decommissioned",
              "not_commissioned"
            ],
            "readOnly": true
          },
          "occurredAt": {
            "description": "Date and time of the commission/decommission event in ISO8601 format (UTC). It is shown only for commissioned and decommissioned states.",
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "TagsDocument": {
        "type": "array",
        "description": "Array of string tags associated with this resource.",
        "items": {
          "type": "string",
          "maxLength": 256,
          "maximum": 60
        }
      },
      "TaskCompletedAtField": {
        "type": "integer",
        "description": "Time at which the task was completed.",
        "readOnly": true
      },
      "TaskLogDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "A single task error log entry.",
        "properties": {
          "jobId": {
            "type": "string",
            "description": "The ID of the task associated with this entry.",
            "readOnly": true,
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "payload": {
            "$ref": "#/components/schemas/TaskLogPayloadDocument"
          },
          "type": {
            "type": "string",
            "description": "The type of log entry.",
            "enum": [
              "ERROR"
            ],
            "readOnly": true
          },
          "message": {
            "type": "string",
            "description": "A description of the nature of the error.",
            "readOnly": true
          }
        }
      },
      "TaskLogPayloadDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "The task payload parameters.",
        "properties": {
          "shortId": {
            "type": "string",
            "description": "The short ID."
          },
          "thng": {
            "type": "string",
            "description": "ID of the Thng.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "thngIdentifier": {
            "type": "object",
            "description": "Key-value pair of the Thng identifier."
          },
          "urlBinding": {
            "type": "string",
            "description": "ID of the URL binding for this Thng."
          }
        }
      },
      "TaskProgressDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Description of the task progress in terms of individual contributions.",
        "properties": {
          "contributions": {
            "$ref": "#/components/schemas/ContributionsDocument"
          },
          "totalAmount": {
            "type": "integer",
            "description": "The total amount of generated resources so far.",
            "readOnly": true
          }
        }
      },
      "TaskResultDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Description of the result of a batch task.",
        "properties": {
          "totalCount": {
            "type": "integer",
            "description": "The total count of generated resources.",
            "readOnly": true
          },
          "totalThngsCreated": {
            "type": "integer",
            "description": "The total count of generated Thngs.",
            "readOnly": true
          },
          "totalUrlBindingsCreated": {
            "type": "integer",
            "description": "The total count of generated redirections.",
            "readOnly": true
          },
          "location": {
            "type": "string",
            "description": "The URL of the result file.",
            "readOnly": true
          },
          "format": {
            "$ref": "#/components/schemas/OutputParametersFormatField"
          },
          "headers": {
            "type": "object",
            "description": "Key-value set of HTTP headers.",
            "readOnly": true
          },
          "error": {
            "type": "string",
            "description": "The error message describing what went wrong.",
            "readOnly": true
          },
          "failedOperationsAmount": {
            "type": "integer",
            "description": "Total number of failed operations.",
            "readOnly": true
          },
          "type": {
            "type": "string",
            "description": "The type of result.",
            "enum": [
              "SHORT_ID_GENERATION",
              "POPULATING",
              "ERROR"
            ],
            "readOnly": true
          }
        }
      },
      "TaskStatusField": {
        "type": "string",
        "description": "The status of the task.",
        "enum": [
          "PENDING",
          "EXECUTING",
          "EXECUTED",
          "CANCELLING",
          "FAILED",
          "EXECUTED_WITH_FAILURES"
        ],
        "readOnly": true
      },
      "TaskTypeField": {
        "type": "string",
        "description": "The type of task to perform.",
        "enum": [
          "POPULATING",
          "SHORT_ID_GENERATION"
        ]
      },
      "ThngDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "An object representing a Thng.",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "$ref": "#/components/schemas/NameField"
          },
          "id": {
            "$ref": "#/components/schemas/IdField"
          },
          "createdAt": {
            "$ref": "#/components/schemas/CreatedAtField"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/UpdatedAtField"
          },
          "activatedAt": {
            "type": "integer",
            "description": "Timestamp when the Thng was activated.",
            "readOnly": true
          },
          "type": {
            "$ref": "#/components/schemas/TypeField"
          },
          "tags": {
            "$ref": "#/components/schemas/TagsDocument"
          },
          "description": {
            "$ref": "#/components/schemas/DescriptionField"
          },
          "customFields": {
            "$ref": "#/components/schemas/CustomFieldsDocument"
          },
          "identifiers": {
            "$ref": "#/components/schemas/IdentifiersDocument"
          },
          "product": {
            "type": "string",
            "description": "The Platform ID of a product this Thng is a class of.",
            "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
          },
          "location": {
            "$ref": "#/components/schemas/LocationDocument"
          },
          "properties": {
            "type": "object",
            "description": "A JSON object with key-value pairs describing properties of the Thng.",
            "readOnly": true
          },
          "collections": {
            "description": "An array of collection IDs of any collections this Thng belongs to.",
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
            }
          },
          "createdByTask": {
            "$ref": "#/components/schemas/IdField"
          },
          "batch": {
            "$ref": "#/components/schemas/IdField"
          },
          "scopes": {
            "$ref": "#/components/schemas/ScopesDocument"
          }
        },
        "x-filterable-fields": [
          {
            "name": "collections",
            "type": "list of string",
            "operators": [
              "="
            ]
          },
          {
            "name": "createdAt",
            "type": "number",
            "operators": [
              "<",
              ">"
            ]
          },
          {
            "name": "identifiers.<key>",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "name",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "product",
            "type": "string",
            "operators": [
              "="
            ]
          },
          {
            "name": "tags",
            "type": "list of string",
            "operators": [
              "="
            ]
          }
        ]
      },
      "TimeInfoDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object describing the current time, with timezone info.",
        "properties": {
          "timestamp": {
            "type": "integer",
            "description": "Number of milliseconds since the Epoch.",
            "minimum": 1508749759486,
            "readOnly": true
          }
        }
      },
      "TimeInfoTimezoneDocument": {
        "additionalProperties": false,
        "type": "object",
        "description": "Object describing the current time, with timezone info.",
        "properties": {
          "timestamp": {
            "type": "integer",
            "description": "Number of milliseconds since the Epoch.",
            "minimum": 1508749759486,
            "readOnly": true
          },
          "localTime": {
            "type": "string",
            "description": "The date, time and zone offset specified as per ISO 8601.",
            "readOnly": true
          },
          "nextChange": {
            "type": "integer",
            "description": "when the next change in offset is expected.",
            "readOnly": true
          },
          "offset": {
            "type": "integer",
            "description": "The current offset in milliseconds of the timezone compared to UTC.",
            "minimum": 0,
            "readOnly": true
          }
        }
      },
      "TriggerAppField": {
        "type": "string",
        "description": "The triggering application.",
        "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
        "readOnly": true
      },
      "TriggerUserAnonymousField": {
        "type": "boolean",
        "description": "`true` if the triggering Application User is anonymous, `false` otherwise.",
        "readOnly": true
      },
      "TriggerUserField": {
        "type": "string",
        "description": "The triggering Application User, if any.",
        "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
        "readOnly": true
      },
      "TypeField": {
        "type": "string",
        "description": "Type of this resource. Can be unset with an empty string.",
        "maxLength": 256
      },
      "UnknownDocument": {
        "type": "object",
        "description": "This is a schema to be used when the actual schema is not yet known."
      },
      "UpdatedAtField": {
        "type": "integer",
        "description": "Timestamp when the resource was updated.",
        "readOnly": true,
        "minimum": 0
      }
    }
  }
}