Organizations (v2.0)

https://github.com/folio-org/mod-organizations-storage

Interfaces
/organizations-storage/interfaces

Interfaces

CRUD APIs used to manage interfaces.

/organizations-storage/interfaces

Collection of interface items.

GET /organizations-storage/interfaces

Get list of interfaces

GET /organizations-storage/interfaces

Query Parameters

query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example code
Example:
```
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

["code", "MEDGRANT", "="]
```
totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
```
none
```
offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
```
0
```
limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
```
10
```

Response 200

Returns a list of interface items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of interface records",
  "type": "object",
  "properties": {
    "interfaces": {
      "description": "The list of interfaces in this collection",
      "type": "array",
      "id": "interfaces",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An interface record",
        "properties": {
          "id": {
            "description": "The unique id of this interface",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "name": {
            "description": "The name of this interface",
            "type": "string"
          },
          "uri": {
            "description": "The URI of this interface",
            "type": "string"
          },
          "notes": {
            "description": "The notes for this interface",
            "type": "string"
          },
          "available": {
            "description": "The availability setting for this interface",
            "type": "boolean"
          },
          "deliveryMethod": {
            "description": "The delivery method for this interface",
            "type": "string",
            "enum": [
              "Online",
              "FTP",
              "Email",
              "Other"
            ]
          },
          "statisticsFormat": {
            "description": "The format of the statistics for this interface",
            "type": "string"
          },
          "locallyStored": {
            "description": "The locally stored location of this interface",
            "type": "string"
          },
          "onlineLocation": {
            "description": "The online location for this interface",
            "type": "string"
          },
          "statisticsNotes": {
            "description": "The notes regarding the statistics for this interface",
            "type": "string"
          },
          "type": {
            "description": "Interface types",
            "type": "array",
            "items": {
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "description": "the type of interface",
              "enum": [
                "Admin",
                "End user",
                "Reports",
                "Orders",
                "Invoices",
                "Other"
              ]
            }
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "totalRecords": {
      "description": "The number of interface records returned in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "interfaces",
    "totalRecords"
  ]
}

Example:

{
    "interfaces": [
        {
            "id": "588b5c42-8634-4af7-bc9b-5e0116ed96b6",
            "name": "Sales Portal",
            "uri": "https://www.gobi3.com/Pages/Login.aspx",
            "notes": "This is the store-front for GOBI.",
            "available": true,
            "deliveryMethod": "Online",
            "statisticsFormat": "PDF",
            "locallyStored": "",
            "onlineLocation": "",
            "statisticsNotes": "",
            "type": [
              "Admin"
            ],
             "metadata": {
                "createdDate": "2019-06-06T00:00:00.000+0000",
                "createdByUserId": "16d2457c-d137-11e8-a8d5-f2801f1b9fd1"
             }
        }
    ],
    "totalRecords": 1
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list interfaces -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list interfaces -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /organizations-storage/interfaces

Create a new interface item.

POST /organizations-storage/interfaces

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An interface record",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this interface",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "name": {
      "description": "The name of this interface",
      "type": "string"
    },
    "uri": {
      "description": "The URI of this interface",
      "type": "string"
    },
    "notes": {
      "description": "The notes for this interface",
      "type": "string"
    },
    "available": {
      "description": "The availability setting for this interface",
      "type": "boolean"
    },
    "deliveryMethod": {
      "description": "The delivery method for this interface",
      "type": "string",
      "enum": [
        "Online",
        "FTP",
        "Email",
        "Other"
      ]
    },
    "statisticsFormat": {
      "description": "The format of the statistics for this interface",
      "type": "string"
    },
    "locallyStored": {
      "description": "The locally stored location of this interface",
      "type": "string"
    },
    "onlineLocation": {
      "description": "The online location for this interface",
      "type": "string"
    },
    "statisticsNotes": {
      "description": "The notes regarding the statistics for this interface",
      "type": "string"
    },
    "type": {
      "description": "Interface types",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "the type of interface",
        "enum": [
          "Admin",
          "End user",
          "Reports",
          "Orders",
          "Invoices",
          "Other"
        ]
      }
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false
}

Example:

{
    "name": "Sales Portal",
    "uri": "https://www.gobi3.com/Pages/Login.aspx",
    "notes": "This is the store-front for GOBI.",
    "available": true,
    "deliveryMethod": "Online",
    "statisticsFormat": "PDF",
    "locallyStored": "",
    "onlineLocation": "",
    "statisticsNotes": "",
    "type": []
}

Response 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

Location: required (string)
URI to the created interface item

Body

Media type: application/json

Type: any

Example:

{
    "name": "Sales Portal",
    "uri": "https://www.gobi3.com/Pages/Login.aspx",
    "notes": "This is the store-front for GOBI.",
    "available": true,
    "deliveryMethod": "Online",
    "statisticsFormat": "PDF",
    "locallyStored": "",
    "onlineLocation": "",
    "statisticsNotes": "",
    "type": []
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to add interface -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create interfaces -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /organizations-storage/interfaces/{id}

Retrieve interface item with given {interfaceId}

GET /organizations-storage/interfaces/{id}

URI Parameters

id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a Interface

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An interface record",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this interface",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "name": {
      "description": "The name of this interface",
      "type": "string"
    },
    "uri": {
      "description": "The URI of this interface",
      "type": "string"
    },
    "notes": {
      "description": "The notes for this interface",
      "type": "string"
    },
    "available": {
      "description": "The availability setting for this interface",
      "type": "boolean"
    },
    "deliveryMethod": {
      "description": "The delivery method for this interface",
      "type": "string",
      "enum": [
        "Online",
        "FTP",
        "Email",
        "Other"
      ]
    },
    "statisticsFormat": {
      "description": "The format of the statistics for this interface",
      "type": "string"
    },
    "locallyStored": {
      "description": "The locally stored location of this interface",
      "type": "string"
    },
    "onlineLocation": {
      "description": "The online location for this interface",
      "type": "string"
    },
    "statisticsNotes": {
      "description": "The notes regarding the statistics for this interface",
      "type": "string"
    },
    "type": {
      "description": "Interface types",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "the type of interface",
        "enum": [
          "Admin",
          "End user",
          "Reports",
          "Orders",
          "Invoices",
          "Other"
        ]
      }
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false
}

Example:

{
    "id": "588b5c42-8634-4af7-bc9b-5e0116ed96b6",
    "name": "Sales Portal",
    "uri": "https://www.gobi3.com/Pages/Login.aspx",
    "notes": "This is the store-front for GOBI.",
    "available": true,
    "deliveryMethod": "Online",
    "statisticsFormat": "PDF",
    "locallyStored": "",
    "onlineLocation": "",
    "statisticsNotes": "",
    "type": [
      "End user",
      "Orders"
    ],
    "metadata": {
        "createdDate": "2019-06-06T00:00:00.000+0000",
        "createdByUserId": "16d2457c-d137-11e8-a8d5-f2801f1b9fd1"
    }
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"interface not found"

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /organizations-storage/interfaces/{id}

Delete interface item with given {interfaceId}

DELETE /organizations-storage/interfaces/{id}

URI Parameters

id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a Interface

Response 204

Item deleted successfully

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to delete interface -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"interface not found"

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /organizations-storage/interfaces/{id}

Update interface item with given {interfaceId}

PUT /organizations-storage/interfaces/{id}

URI Parameters

id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a Interface

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An interface record",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this interface",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "name": {
      "description": "The name of this interface",
      "type": "string"
    },
    "uri": {
      "description": "The URI of this interface",
      "type": "string"
    },
    "notes": {
      "description": "The notes for this interface",
      "type": "string"
    },
    "available": {
      "description": "The availability setting for this interface",
      "type": "boolean"
    },
    "deliveryMethod": {
      "description": "The delivery method for this interface",
      "type": "string",
      "enum": [
        "Online",
        "FTP",
        "Email",
        "Other"
      ]
    },
    "statisticsFormat": {
      "description": "The format of the statistics for this interface",
      "type": "string"
    },
    "locallyStored": {
      "description": "The locally stored location of this interface",
      "type": "string"
    },
    "onlineLocation": {
      "description": "The online location for this interface",
      "type": "string"
    },
    "statisticsNotes": {
      "description": "The notes regarding the statistics for this interface",
      "type": "string"
    },
    "type": {
      "description": "Interface types",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "the type of interface",
        "enum": [
          "Admin",
          "End user",
          "Reports",
          "Orders",
          "Invoices",
          "Other"
        ]
      }
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false
}

Example:

{
    "id": "588b5c42-8634-4af7-bc9b-5e0116ed96b6",
    "name": "Sales Portal",
    "uri": "https://www.gobi3.com/Pages/Login.aspx",
    "notes": "This is the store-front for GOBI.",
    "available": true,
    "deliveryMethod": "Online",
    "statisticsFormat": "PDF",
    "locallyStored": "",
    "onlineLocation": "",
    "statisticsNotes": "",
    "type": [
      "End user",
      "Orders"
    ],
    "metadata": {
        "createdDate": "2019-06-06T00:00:00.000+0000",
        "createdByUserId": "16d2457c-d137-11e8-a8d5-f2801f1b9fd1"
    }
}

Response 204

Item successfully updated

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to update interface -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"interface not found"

Response 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /organizations-storage/interfaces/{id}/credentials

Create a new interface credential

POST /organizations-storage/interfaces/{id}/credentials

URI Parameters

id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a Interface

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An interface credential record",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this interface credential",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "username": {
      "description": "The login username for this interface",
      "type": "string"
    },
    "password": {
      "description": "The login password for this interface",
      "type": "string"
    },
    "interfaceId": {
      "description": "The unique id of the associated interface",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "interfaceId",
    "username",
    "password"
  ]
}

Example:

{
  "id": "2552dadb-aa4e-4d58-ad99-f09384a53018",
  "username": "my_user",
  "password": "my_password",
  "interfaceId" : "588b5c42-8634-4af7-bc9b-5e0116ed96b6"
}

Response 201

Returns a newly created interface credential, with server-controlled fields like 'id' populated

Headers

Location: required (string)
URI to the created interface credential

Body

Media type: application/json

Type: any

Example:

{
  "id": "2552dadb-aa4e-4d58-ad99-f09384a53018",
  "username": "my_user",
  "password": "my_password",
  "interfaceId" : "588b5c42-8634-4af7-bc9b-5e0116ed96b6"
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to add interface credential -- malformed JSON at 13:3

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create interface credential -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /organizations-storage/interfaces/{id}/credentials

Retrieve credential item with given {credentialId}

GET /organizations-storage/interfaces/{id}/credentials

URI Parameters

id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a Interface

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An interface credential record",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this interface credential",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "username": {
      "description": "The login username for this interface",
      "type": "string"
    },
    "password": {
      "description": "The login password for this interface",
      "type": "string"
    },
    "interfaceId": {
      "description": "The unique id of the associated interface",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "interfaceId",
    "username",
    "password"
  ]
}

Example:

{
  "id": "2552dadb-aa4e-4d58-ad99-f09384a53018",
  "username": "my_user",
  "password": "my_password",
  "interfaceId" : "588b5c42-8634-4af7-bc9b-5e0116ed96b6"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"credential not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /organizations-storage/interfaces/{id}/credentials

Delete credential item with given {credentialId}

DELETE /organizations-storage/interfaces/{id}/credentials

URI Parameters

id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a Interface

Response 204

Item deleted successfully

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to delete credential -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"credential not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /organizations-storage/interfaces/{id}/credentials

Update credential item with given {credentialId}

PUT /organizations-storage/interfaces/{id}/credentials

URI Parameters

id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a Interface

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An interface credential record",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this interface credential",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "username": {
      "description": "The login username for this interface",
      "type": "string"
    },
    "password": {
      "description": "The login password for this interface",
      "type": "string"
    },
    "interfaceId": {
      "description": "The unique id of the associated interface",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "interfaceId",
    "username",
    "password"
  ]
}

Example:

{
  "id": "2552dadb-aa4e-4d58-ad99-f09384a53018",
  "username": "my_user",
  "password": "my_password",
  "interfaceId" : "588b5c42-8634-4af7-bc9b-5e0116ed96b6"
}

Response 204

Item successfully updated

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to update credential -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"credential not found"

Response 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Organizations (v2.0)

Table of contents

Interfaces

/organizations-storage/interfaces

GET /organizations-storage/interfaces

Query Parameters

Response 200

Response 400

Response 401

Response 422

Response 500

POST /organizations-storage/interfaces

Response 201

Headers

Response 400

Response 401

Response 422

Response 500

GET /organizations-storage/interfaces/{id}

URI Parameters

Response 200

Response 404

Response 422

Response 500

DELETE /organizations-storage/interfaces/{id}

URI Parameters

Response 204

Response 400

Response 404

Response 422

Response 500

PUT /organizations-storage/interfaces/{id}

URI Parameters

Response 204

Response 400

Response 404

Response 409

Response 422

Response 500

POST /organizations-storage/interfaces/{id}/credentials

URI Parameters

Response 201

Headers

Response 400

Response 401

Response 500

GET /organizations-storage/interfaces/{id}/credentials

URI Parameters

Response 200

Response 404

Response 500

DELETE /organizations-storage/interfaces/{id}/credentials

URI Parameters

Response 204

Response 400

Response 404

Response 500

PUT /organizations-storage/interfaces/{id}/credentials

URI Parameters

Response 204

Response 400

Response 404

Response 409

Response 500