Reports Metadata

Reports Metadata

Set Admin Credentials...
retrieveMetadata

GET

/reports/metadata

Returns available list of reports that the user is entitled to view.

Prod:
https://api.seic.com/v2/reports/metadata
Query Parameters
Name Description Data Type Required
limit

Number of records per page. Many responses have a maximum of 50 records per page.

string

reportName

The name of the report

string

Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
limit

Number of records per page. Many responses have a maximum of 50 records per page.
reportName

The name of the report
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Reports Metadata

Set Admin Credentials...
retrieveMetadata

GET

/reports/metadata

Returns available list of reports that the user is entitled to view.

Prod:
https://api.seic.com/v2/reports/metadata
Query Parameters
Name Description Data Type Required
limit

Number of records per page. Many responses have a maximum of 50 records per page.

string

reportName

The name of the report

string

Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
limit

Number of records per page. Many responses have a maximum of 50 records per page.
reportName

The name of the report
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...
Test: https://test.api.seic.com/v2/reports/metadata
TLS*: https://mtls.api.seic.com/v2/reports/metadata
*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.
STEP 1

oAuthToken
POST



Pass the oAuth Token and the App key to invoke this endpoint for a particular application.

Reports Metadata

Set Admin Credentials...
retrieveMetadata

GET

/reports/metadata

Returns available list of reports that the user is entitled to view.

Prod:
https://api.seic.com/v2/reports/metadata
Query Parameters
Name Description Data Type Required
limit

Number of records per page. Many responses have a maximum of 50 records per page.

string

reportName

The name of the report

string

Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
limit

Number of records per page. Many responses have a maximum of 50 records per page.
reportName

The name of the report
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...
SAMPLE REQUEST

curl -X GET \
  'https://api.seic.com/v2/reports/metadata' \
  -H 'AppKey: gsedgaerhDSHGRSH' \
  -H 'Authorization: Bearer ADsgdnnkjnfdIKJN’ \


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
REQUEST PAYLOAD MODEL
Operations
RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9


SAMPLE RESPONSE

{
  "data": {
    "reports": [
      {
        "name": "SEI Trial Balance",
        "parameters": [
          {
            "name": "format",
            "required": false,
            "description": ""
          },
          {
            "name": "knowledgeDate",
            "required": false,
            "description": ""
          },
          {
            "name": "name",
            "required": false,
            "description": ""
          },
          {
            "name": "portfolio",
            "required": true,
            "description": ""
          },
          {
            "name": "requestName",
            "required": false,
            "description": ""
          },
          {
            "name": "accountingCalendar",
            "required": true,
            "description": ""
          },
          {
            "name": "periodEndDate",
            "required": false,
            "description": ""
          },
          {
            "name": "priorKnowledgeDate",
            "required": false,
            "description": ""
          },
          {
            "name": "periodStartDate",
            "required": false,
            "description": ""
          },
          {
            "name": "accountingRunType",
            "required": false,
            "description": ""
          },
          {
            "name": "accountingPeriod",
            "required": false,
            "description": ""
          }
        ]
      }
    ]
  }
}
MODEL
Operations
Name Description Data Type (L)
name

Name of the report. The user is expected to use the key value pairs returned by this API to construct the payload for POST report generation request.

 string
mandatoryParameters

List of mandatory key:value pairs per report. The user is expected to use the key value pairs returned by this API to construct the payload for POST report generation request.

 object
optionalParameters

List of optional key:value pairs per report. The user is expected to use the key value pairs returned by this API to construct the payload for POST report generation request.

 object
description

This field holds additional information about the field, and is provided during setup.

 string
required

This represents whether a particular parameter is mandatory or not.

 string
parameters

The conditions that we need to supply in order to run a report

 string


Reports Metadata

Set Admin Credentials...
retrieveMetadata

GET

/reports/metadata

Returns available list of reports that the user is entitled to view.

Prod:
https://api.seic.com/v2/reports/metadata
Query Parameters
Name Description Data Type Required
limit

Number of records per page. Many responses have a maximum of 50 records per page.

string

reportName

The name of the report

string

Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
limit

Number of records per page. Many responses have a maximum of 50 records per page.
reportName

The name of the report
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Reports Metadata

Set Admin Credentials...
retrieveMetadata

GET

/reports/metadata

Returns available list of reports that the user is entitled to view.

Prod:
https://api.seic.com/v2/reports/metadata
Query Parameters
Name Description Data Type Required
limit

Number of records per page. Many responses have a maximum of 50 records per page.

string

reportName

The name of the report

string

Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
limit

Number of records per page. Many responses have a maximum of 50 records per page.
reportName

The name of the report
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...
Test: https://test.api.seic.com/v2/reports/metadata
TLS*: https://mtls.api.seic.com/v2/reports/metadata
*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.
STEP 1

oAuthToken
POST



Pass the oAuth Token and the App key to invoke this endpoint for a particular application.

Reports Metadata

Set Admin Credentials...
retrieveMetadata

GET

/reports/metadata

Returns available list of reports that the user is entitled to view.

Prod:
https://api.seic.com/v2/reports/metadata
Query Parameters
Name Description Data Type Required
limit

Number of records per page. Many responses have a maximum of 50 records per page.

string

reportName

The name of the report

string

Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
limit

Number of records per page. Many responses have a maximum of 50 records per page.
reportName

The name of the report
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...
SAMPLE REQUEST

curl -X GET \
  'https://api.seic.com/v2/reports/metadata' \
  -H 'AppKey: gsedgaerhDSHGRSH' \
  -H 'Authorization: Bearer ADsgdnnkjnfdIKJN’ \


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
REQUEST PAYLOAD MODEL
Operations
RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9


SAMPLE RESPONSE

{
  "data": {
    "reports": [
      {
        "name": "SEI Trial Balance",
        "parameters": [
          {
            "name": "format",
            "required": false,
            "description": ""
          },
          {
            "name": "knowledgeDate",
            "required": false,
            "description": ""
          },
          {
            "name": "name",
            "required": false,
            "description": ""
          },
          {
            "name": "portfolio",
            "required": true,
            "description": ""
          },
          {
            "name": "requestName",
            "required": false,
            "description": ""
          },
          {
            "name": "accountingCalendar",
            "required": true,
            "description": ""
          },
          {
            "name": "periodEndDate",
            "required": false,
            "description": ""
          },
          {
            "name": "priorKnowledgeDate",
            "required": false,
            "description": ""
          },
          {
            "name": "periodStartDate",
            "required": false,
            "description": ""
          },
          {
            "name": "accountingRunType",
            "required": false,
            "description": ""
          },
          {
            "name": "accountingPeriod",
            "required": false,
            "description": ""
          }
        ]
      }
    ]
  }
}
MODEL
Operations
Name Description Data Type (L)
name

Name of the report. The user is expected to use the key value pairs returned by this API to construct the payload for POST report generation request.

 string
mandatoryParameters

List of mandatory key:value pairs per report. The user is expected to use the key value pairs returned by this API to construct the payload for POST report generation request.

 object
optionalParameters

List of optional key:value pairs per report. The user is expected to use the key value pairs returned by this API to construct the payload for POST report generation request.

 object
description

This field holds additional information about the field, and is provided during setup.

 string
required

This represents whether a particular parameter is mandatory or not.

 string
parameters

The conditions that we need to supply in order to run a report

 string


Reports Metadata

Set Admin Credentials...
retrieveMetadata

GET

/reports/metadata

Returns available list of reports that the user is entitled to view.

Prod:
https://api.seic.com/v2/reports/metadata
Query Parameters
Name Description Data Type Required
limit

Number of records per page. Many responses have a maximum of 50 records per page.

string

reportName

The name of the report

string

Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections

  • 500

    Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT
limit

Number of records per page. Many responses have a maximum of 50 records per page.
reportName

The name of the report
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...