Put an document for an id4n

v1.0.0

Creating or overwriting an existing document

Input

{
  "type": "object",
  "properties": {
    "id4n": {
      "type": "string"
    },
    "organizationId": {
      "type": "string"
    }
  },
  "required": [
    "id4n",
    "organizationId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "description": "File Name"
    },
    "mimeType": {
      "type": "string",
      "description": "Mime Type"
    },
    "ownerOrganizationId": {
      "type": "string",
      "description": "The organization's namespace which owns the document"
    },
    "visibility": {
      "type": "object",
      "properties": {
        "public": {
          "type": "boolean",
          "description": "Document is publicly readable (if ID4N is owned by the same organization)"
        },
        "sharedOrganizationIds": {
          "type": "array",
          "description": "Document is readable by these organizations (independend of ID4N ownership)",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}