{
  "opencollection": "1.0.0",
  "info": {
    "name": "TrustLayer Platform Auth custom-fields API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "custom-fields",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Update a custom field",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:4000/v1/projects/:projectId",
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Note\n\n* required attributes (`name` and `fieldType`) _must_ always be specified\n* at the moment it's not possible to specify custom requirementsand checklists."
        },
        {
          "info": {
            "name": "List custom fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:4000/v1/custom-fields"
          },
          "docs": "All fields are returned in alphabetical order; pagination and sorting are not enabled.\n\nAvailable include options:\n* `complianceProfile`"
        },
        {
          "info": {
            "name": "Create a new custom field",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:4000/v1/custom-fields",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Note: at the moment it's not possible to specify custom requirements and checklists."
        },
        {
          "info": {
            "name": "Update a custom field",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:4000/v1/custom-fields/:fieldId",
            "params": [
              {
                "name": "fieldId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Note that by specifying `options` you will _replace_ all the existing values."
        },
        {
          "info": {
            "name": "Delete a custom field",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:4000/v1/custom-fields/:fieldId",
            "params": [
              {
                "name": "fieldId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This will also remove the field from any project that is using it."
        },
        {
          "info": {
            "name": "Update party custom data",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:4000/v1/parties/:partyId/custom-data",
            "params": [
              {
                "name": "partyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scope[type]",
                "value": "",
                "type": "query",
                "description": "Type of the resource to be used as scope"
              },
              {
                "name": "scope[id]",
                "value": "",
                "type": "query",
                "description": "Id of the resource to be used as scope"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add, remove or update party custom fields.\n\nTo remove a field, set its value to `null`.\n\nA project `scope` can be specified; in that case the changes will be made only to the project specific values."
        }
      ]
    }
  ],
  "bundled": true
}