Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Open api
{
  "swagger": "2.0",
  "info": {
    "description": "The Node Task Management API is used to help manage complex multi-node XNAT infrastructure environments.",
    "version": "1.7.4.1",
    "title": "XNAT Node/Task Management API"
  },
  "tags": [
    {
      "name": "xnat-task-api",
      "description": "XNAT Node/Task Management API"
    }
  ],

  "definitions": {
    "HttpSession": {
      "type": "object",
      "properties": {}
    },
    "Validated": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "valid": {
          "type": "boolean"
        }
      }
    },
    "User": {
      "type": "object",
      "properties": {
        "admin": {
          "type": "boolean",
          "description": "Whether the user is a site administrator."
        },
        "authorization": {
          "description": "The user's authorization record used when logging in.",
          "$ref": "#\/definitions\/UserAuthI"
        },
        "email": {
          "type": "string",
          "description": "The user's email address."
        },
        "enabled": {
          "type": "boolean",
          "description": "Whether the user is enabled."
        },
        "firstName": {
          "type": "string",
          "description": "The user's first name."
        },
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "The user's unique key."
        },
        "lastModified": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time the user record was last modified."
        },
        "lastName": {
          "type": "string",
          "description": "The user's last name."
        },
        "password": {
          "type": "string",
          "description": "The user's encrypted password."
        },
        "salt": {
          "type": "string",
          "description": "The salt used to encrypt the user's password."
        },
        "secured": {
          "type": "boolean",
          "description": "Indicates whether the user object is secured, which causes secure fields like password and salt to return null."
        },
        "username": {
          "type": "string",
          "description": "The user's login name."
        },
        "verified": {
          "type": "boolean",
          "description": "Whether the user is verified."
        }
      },
      "description": "Contains the properties that define a user on the system."
    },
    "Iterable\u00c2\u00abstring\u00c2\u00bb": {
      "type": "object"
    },
    "EventHandlerFilterInfo": {
      "type": "object",
      "properties": {
        "defaultValue": {
          "type": "string",
          "description": "Default selected value for event filter values"
        },
        "filterRequired": {
          "type": "boolean",
          "description": "Filter Required?"
        },
        "filterValues": {
          "type": "array",
          "description": "Filter Values",
          "items": {
            "type": "string"
          }
        },
        "includeValuesFromDatabase": {
          "type": "boolean",
          "description": "Include Values From Database?"
        }
      },
      "description": "Event class names and filterable fields."
    },
    "JsonNode": {
      "type": "object",
      "properties": {
        "array": {
          "type": "boolean"
        },
        "bigDecimal": {
          "type": "boolean"
        },
        "bigInteger": {
          "type": "boolean"
        },
        "binary": {
          "type": "boolean"
        },
        "boolean": {
          "type": "boolean"
        },
        "containerNode": {
          "type": "boolean"
        },
        "double": {
          "type": "boolean"
        },
        "float": {
          "type": "boolean"
        },
        "floatingPointNumber": {
          "type": "boolean"
        },
        "int": {
          "type": "boolean"
        },
        "integralNumber": {
          "type": "boolean"
        },
        "long": {
          "type": "boolean"
        },
        "missingNode": {
          "type": "boolean"
        },
        "nodeType": {
          "type": "string",
          "enum": [
            "ARRAY",
            "BINARY",
            "BOOLEAN",
            "MISSING",
            "NULL",
            "NUMBER",
            "OBJECT",
            "POJO",
            "STRING"
          ]
        },
        "null": {
          "type": "boolean"
        },
        "number": {
          "type": "boolean"
        },
        "object": {
          "type": "boolean"
        },
        "pojo": {
          "type": "boolean"
        },
        "short": {
          "type": "boolean"
        },
        "textual": {
          "type": "boolean"
        },
        "valueNode": {
          "type": "boolean"
        }
      }
    },
    "EventClassInfo": {
      "type": "object",
      "properties": {
        "class": {
          "type": "string",
          "description": "Event class name (Should implement AutomationEventImplementerI"
        },
        "description": {
          "type": "string",
          "description": "Description"
        },
        "displayName": {
          "type": "string",
          "description": "Display Name"
        },
        "eventIds": {
          "type": "array",
          "description": "List of event IDs.",
          "items": {
            "type": "string"
          }
        },
        "filterableFields": {
          "type": "object",
          "description": "Map of Filterable fields.",
          "additionalProperties": {
            "$ref": "#\/definitions\/EventHandlerFilterInfo"
          }
        },
        "includeEventIdsFromDatabase": {
          "type": "boolean"
        }
      },
      "description": "Event class names and filterable fields."
    },
    "Investigator": {
      "type": "object",
      "properties": {
        "department": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "firstname": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "institution": {
          "type": "string"
        },
        "investigatorProjects": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "lastname": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "primaryProjects": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "title": {
          "type": "string"
        },
        "xnatInvestigatordataId": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "ThemeConfig": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "path": {
          "type": "string"
        },
        "roles": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    "Map\u00c2\u00abstring,string\u00c2\u00bb": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "TypeOption": {
      "type": "object",
      "properties": {
        "label": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "DicomSCP": {
      "type": "object",
      "properties": {
        "aes": {
          "$ref": "#\/definitions\/Iterable\u00c2\u00abstring\u00c2\u00bb"
        },
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "port": {
          "type": "integer",
          "format": "int32"
        },
        "started": {
          "type": "boolean"
        }
      }
    },
    "Collection": {
      "type": "object"
    },
    "Collection\u00c2\u00abstring\u00c2\u00bb": {
      "type": "object"
    },
    "DicomSCPInstance": {
      "type": "object",
      "properties": {
        "aeTitle": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "fileNamer": {
          "type": "string"
        },
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "identifier": {
          "type": "string"
        },
        "port": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "SpawnerElement": {
      "type": "object",
      "properties": {
        "created": {
          "type": "string",
          "format": "date-time"
        },
        "description": {
          "type": "string"
        },
        "disabled": {
          "type": "string",
          "format": "date-time"
        },
        "elementId": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "label": {
          "type": "string"
        },
        "namespace": {
          "type": "string"
        },
        "timestamp": {
          "type": "string",
          "format": "date-time"
        },
        "yaml": {
          "type": "string"
        }
      }
    },
    "UserAuthI": {
      "type": "object",
      "properties": {
        "authMethod": {
          "type": "string"
        },
        "authMethodId": {
          "type": "string"
        },
        "authUser": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "failedLoginAttempts": {
          "type": "integer",
          "format": "int32"
        },
        "lastLoginAttempt": {
          "type": "string",
          "format": "date-time"
        },
        "lastSuccessfulLogin": {
          "type": "string",
          "format": "date-time"
        },
        "passwordUpdated": {
          "type": "string",
          "format": "date-time"
        },
        "xdatUsername": {
          "type": "string"
        }
      }
    },
    "XnatPluginBean": {
      "type": "object",
      "properties": {
        "beanName": {
          "type": "string"
        },
        "dataModelBeans": {
          "type": "array",
          "items": {
            "$ref": "#\/definitions\/XnatDataModelBean"
          }
        },
        "description": {
          "type": "string"
        },
        "entityPackages": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "namespace": {
          "type": "string"
        },
        "pluginClass": {
          "type": "string"
        }
      }
    },
    "XnatDataModelBean": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "plural": {
          "type": "string"
        },
        "secured": {
          "type": "boolean"
        },
        "singular": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    }
  },
  "paths": {
    "/xapi/xnatTask/checkNodeConfigurationStatus": {"get": {
      "tags": ["xnat-task-api"],
      "summary": "Get node configuration status.",
      "description": "Returns node configuration status for this installation.",
      "operationId": "getNodeConfigurationStatusUsingGET",
      "consumes": ["application/json"],
      "produces": ["application/json"],
      "responses": {
        "200": {
          "description": "An array of properties",
          "schema": {
            "type": "object",
            "additionalProperties": {"type": "object"}
          }
        },
        "401": {"description": "Unauthorized"},
        "500": {"description": "Unexpected error"},
        "403": {"description": "Forbidden"},
        "404": {"description": "Not Found"}
      }
    }},
    "/xapi/xnatTask/taskList": {"get": {
      "tags": ["xnat-task-api"],
      "summary": "Get list of XnatTask classes.",
      "description": "Returns a list of XnatTask properties",
      "operationId": "getTaskListUsingGET",
      "consumes": ["application/json"],
      "produces": ["application/json"],
      "responses": {
        "200": {
          "description": "An array of properties",
          "schema": {
            "type": "array",
            "items": {"type": "string"}
          }
        },
        "401": {"description": "Unauthorized"},
        "500": {"description": "Unexpected error"},
        "403": {"description": "Forbidden"},
        "404": {"description": "Not Found"}
      }
    }}
  }
}

...