Aggregator Settings (v1.2)

http://localhost/mod-erm-usage

Table of contents

mod-erm-usage API

This documents the API calls that can be made to query and manage aggregator settings

Aggregator Settings

Collection of aggregator-setting items.

GET /aggregator-settings

Get all aggregator settings

GET /aggregator-settings
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.

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

(label="Server*") and aggregatorConfig.reportRelease="4"
  • orderBy: (string)

    Order by field: label

  • order: (one of desc, asc - default: desc)

    Order

  • 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. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords

    Example:

    10

Response 200

Returns a list of aggregator-setting items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "List of AggregatorSettings",
  "type": "object",
  "properties": {
    "aggregatorSettings": {
      "type": "array",
      "description": "Entries",
      "id": "aggregatorsettings",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Aggregator Settings Schema",
        "title": "Aggregator Settings Schema",
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "description": "Aggregator label",
            "type": "string"
          },
          "serviceType": {
            "type": "string",
            "description": "Specifies implementation specific for this aggregator as defined in mod-erm-usage-harvester."
          },
          "serviceUrl": {
            "type": "string",
            "description": "Aggregator’s service URL to use for harvesting."
          },
          "aggregatorConfig": {
            "type": "object",
            "description": "Additional key/value pairs for aggregator configuration"
          },
          "accountConfig": {
            "description": "Account configuration",
            "type": "object",
            "properties": {
              "configType": {
                "description": "Specifies how the vendor's access parameters are submitted to the aggregator. These parameters are used by the aggregator to login into the vendor in order to fetch the usage data.",
                "type": "string",
                "enum": [
                  "Mail",
                  "API",
                  "Manual"
                ]
              },
              "configMail": {
                "description": "Given if configType == mail",
                "type": "string"
              },
              "displayContact": {
                "description": "Free text info to display to the user with the SUSHI settings in the eUsage app frontend.",
                "type": "array",
                "minItems": 0,
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "configType"
            ]
          },
          "metadata": {
            "description": "Metadata about creation and changes, provided by the server (client should not provide)",
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "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"
            ]
          }
        },
        "required": [
          "label",
          "serviceType",
          "serviceUrl",
          "accountConfig"
        ],
        "additionalProperties": true
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "aggregatorSettings",
    "totalRecords"
  ]
}

Example:

{
  "aggregatorSettings": [
    {
      "id": "4c66b956-23a8-4418-aef6-1c35dcdaccc4",
      "label": "ACM Digital Library",
      "serviceType": "My Service",
      "serviceUrl": "www.myaggregator.com",
      "aggregatorConfig": {
        "apiKey": "abc",
        "requestorId": "def",
        "customerId": "ghi",
        "reportRelease": "4"
      },
      "accountConfig": {
        "configType": "Manual",
        "configMail": "ab@counter-stats.com",
        "displayContact": ["Counter Aggregator Contact", "Tel: +49 1234 - 9876"]
      }
    }
  ],
  "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 aggregator-settings -- 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 aggregator-settings -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /aggregator-settings

Post new aggregator settings

POST /aggregator-settings
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Aggregator Settings Schema",
  "title": "Aggregator Settings Schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "label": {
      "description": "Aggregator label",
      "type": "string"
    },
    "serviceType": {
      "type": "string",
      "description": "Specifies implementation specific for this aggregator as defined in mod-erm-usage-harvester."
    },
    "serviceUrl": {
      "type": "string",
      "description": "Aggregator’s service URL to use for harvesting."
    },
    "aggregatorConfig": {
      "type": "object",
      "description": "Additional key/value pairs for aggregator configuration"
    },
    "accountConfig": {
      "description": "Account configuration",
      "type": "object",
      "properties": {
        "configType": {
          "description": "Specifies how the vendor's access parameters are submitted to the aggregator. These parameters are used by the aggregator to login into the vendor in order to fetch the usage data.",
          "type": "string",
          "enum": [
            "Mail",
            "API",
            "Manual"
          ]
        },
        "configMail": {
          "description": "Given if configType == mail",
          "type": "string"
        },
        "displayContact": {
          "description": "Free text info to display to the user with the SUSHI settings in the eUsage app frontend.",
          "type": "array",
          "minItems": 0,
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "configType"
      ]
    },
    "metadata": {
      "description": "Metadata about creation and changes, provided by the server (client should not provide)",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "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"
      ]
    }
  },
  "required": [
    "label",
    "serviceType",
    "serviceUrl",
    "accountConfig"
  ],
  "additionalProperties": true
}

Example:

{
  "id": "4c66b956-23a8-4418-aef6-1c35dcdaccc4",
  "label": "ACM Digital Library",
  "serviceType": "My Service",
  "serviceUrl": "www.myaggregator.com",
  "aggregatorConfig": {
    "apiKey": "abc",
    "requestorId": "def",
    "customerId": "ghi",
    "reportRelease": "4"
  },
  "accountConfig": {
    "configType": "Manual",
    "configMail": "ab@counter-stats.com",
    "displayContact": ["Counter Aggregator Contact", "Tel: +49 1234 - 9876"]
  }
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created aggregator-setting item

Body

Media type: application/json

Type: any

Example:

{
  "id": "4c66b956-23a8-4418-aef6-1c35dcdaccc4",
  "label": "ACM Digital Library",
  "serviceType": "My Service",
  "serviceUrl": "www.myaggregator.com",
  "aggregatorConfig": {
    "apiKey": "abc",
    "requestorId": "def",
    "customerId": "ghi",
    "reportRelease": "4"
  },
  "accountConfig": {
    "configType": "Manual",
    "configMail": "ab@counter-stats.com",
    "displayContact": ["Counter Aggregator Contact", "Tel: +49 1234 - 9876"]
  }
}

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 aggregator-setting -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create aggregator-settings -- 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 /aggregator-settings/{id}

Get one aggregator setting identified by id

GET /aggregator-settings/{id}
URI Parameters
  • id: required (string)

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": "Aggregator Settings Schema",
  "title": "Aggregator Settings Schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "label": {
      "description": "Aggregator label",
      "type": "string"
    },
    "serviceType": {
      "type": "string",
      "description": "Specifies implementation specific for this aggregator as defined in mod-erm-usage-harvester."
    },
    "serviceUrl": {
      "type": "string",
      "description": "Aggregator’s service URL to use for harvesting."
    },
    "aggregatorConfig": {
      "type": "object",
      "description": "Additional key/value pairs for aggregator configuration"
    },
    "accountConfig": {
      "description": "Account configuration",
      "type": "object",
      "properties": {
        "configType": {
          "description": "Specifies how the vendor's access parameters are submitted to the aggregator. These parameters are used by the aggregator to login into the vendor in order to fetch the usage data.",
          "type": "string",
          "enum": [
            "Mail",
            "API",
            "Manual"
          ]
        },
        "configMail": {
          "description": "Given if configType == mail",
          "type": "string"
        },
        "displayContact": {
          "description": "Free text info to display to the user with the SUSHI settings in the eUsage app frontend.",
          "type": "array",
          "minItems": 0,
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "configType"
      ]
    },
    "metadata": {
      "description": "Metadata about creation and changes, provided by the server (client should not provide)",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "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"
      ]
    }
  },
  "required": [
    "label",
    "serviceType",
    "serviceUrl",
    "accountConfig"
  ],
  "additionalProperties": true
}

Example:

{
  "id": "4c66b956-23a8-4418-aef6-1c35dcdaccc4",
  "label": "ACM Digital Library",
  "serviceType": "My Service",
  "serviceUrl": "www.myaggregator.com",
  "aggregatorConfig": {
    "apiKey": "abc",
    "requestorId": "def",
    "customerId": "ghi",
    "reportRelease": "4"
  },
  "accountConfig": {
    "configType": "Manual",
    "configMail": "ab@counter-stats.com",
    "displayContact": ["Counter Aggregator Contact", "Tel: +49 1234 - 9876"]
  }
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"aggregator-setting 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 /aggregator-settings/{id}

Delete aggregator setting identified by id

DELETE /aggregator-settings/{id}
URI Parameters
  • id: required (string)

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 aggregator-setting -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"aggregator-setting 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 /aggregator-settings/{id}

Put aggregator setting identified by id

PUT /aggregator-settings/{id}
URI Parameters
  • id: required (string)
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Aggregator Settings Schema",
  "title": "Aggregator Settings Schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "label": {
      "description": "Aggregator label",
      "type": "string"
    },
    "serviceType": {
      "type": "string",
      "description": "Specifies implementation specific for this aggregator as defined in mod-erm-usage-harvester."
    },
    "serviceUrl": {
      "type": "string",
      "description": "Aggregator’s service URL to use for harvesting."
    },
    "aggregatorConfig": {
      "type": "object",
      "description": "Additional key/value pairs for aggregator configuration"
    },
    "accountConfig": {
      "description": "Account configuration",
      "type": "object",
      "properties": {
        "configType": {
          "description": "Specifies how the vendor's access parameters are submitted to the aggregator. These parameters are used by the aggregator to login into the vendor in order to fetch the usage data.",
          "type": "string",
          "enum": [
            "Mail",
            "API",
            "Manual"
          ]
        },
        "configMail": {
          "description": "Given if configType == mail",
          "type": "string"
        },
        "displayContact": {
          "description": "Free text info to display to the user with the SUSHI settings in the eUsage app frontend.",
          "type": "array",
          "minItems": 0,
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "configType"
      ]
    },
    "metadata": {
      "description": "Metadata about creation and changes, provided by the server (client should not provide)",
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "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"
      ]
    }
  },
  "required": [
    "label",
    "serviceType",
    "serviceUrl",
    "accountConfig"
  ],
  "additionalProperties": true
}

Example:

{
  "id": "4c66b956-23a8-4418-aef6-1c35dcdaccc4",
  "label": "ACM Digital Library",
  "serviceType": "My Service",
  "serviceUrl": "www.myaggregator.com",
  "aggregatorConfig": {
    "apiKey": "abc",
    "requestorId": "def",
    "customerId": "ghi",
    "reportRelease": "4"
  },
  "accountConfig": {
    "configType": "Manual",
    "configMail": "ab@counter-stats.com",
    "displayContact": ["Counter Aggregator Contact", "Tel: +49 1234 - 9876"]
  }
}

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 aggregator-setting -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"aggregator-setting 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

GET /aggregator-settings/{id}/exportcredentials

Get SushiCredentials associated with this aggregator

GET /aggregator-settings/{id}/exportcredentials
URI Parameters
  • id: required (string)
Query Parameters
  • format: (string - default: csv)

    Specify export format (default is CSV)

Response 200

Ok

Body

Media type: text/csv

Type: any

Media type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Type: any

Response 400

Bad Request

Body

Media type: text/plain

Type: any

Response 500

Error

Body

Media type: text/plain

Type: any