SEI Developer Portal | Retrieve Files

Retrieve Files

GET

/files

Returns Search Results - Searches files/documents in the content repository.

Prod:

https://api.seic.com/v2/contentmanagement/files

Query Parameters

Name	Description	Data Type
appId	Application Id, Default is “aca”	string
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing	string
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…	string
searchText	Search Strings	string
sortOrder	Results Sort Order (asc/desc)	string
mode	Default mode is ‘client’	string
logic	Logic is AND/OR	string
limit	Number of results	integer

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

appId	Application Id, Default is “aca”
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…
searchText	Search Strings
sortOrder	Results Sort Order (asc/desc)
mode	Default mode is ‘client’
logic	Logic is AND/OR
limit	Number of results

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Retrieve Files

GET

/files

Returns Search Results - Searches files/documents in the content repository.

Prod:

https://api.seic.com/v2/contentmanagement/files

Query Parameters

Name	Description	Data Type
appId	Application Id, Default is “aca”	string
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing	string
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…	string
searchText	Search Strings	string
sortOrder	Results Sort Order (asc/desc)	string
mode	Default mode is ‘client’	string
logic	Logic is AND/OR	string
limit	Number of results	integer

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

appId	Application Id, Default is “aca”
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…
searchText	Search Strings
sortOrder	Results Sort Order (asc/desc)
mode	Default mode is ‘client’
logic	Logic is AND/OR
limit	Number of results

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v2/contentmanagement/files

TLS*: https://mtls.api.seic.com/v2/contentmanagement/files

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 2

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

Retrieve Files

GET

/files

Returns Search Results - Searches files/documents in the content repository.

Prod:

https://api.seic.com/v2/contentmanagement/files

Query Parameters

Name	Description	Data Type
appId	Application Id, Default is “aca”	string
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing	string
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…	string
searchText	Search Strings	string
sortOrder	Results Sort Order (asc/desc)	string
mode	Default mode is ‘client’	string
logic	Logic is AND/OR	string
limit	Number of results	integer

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

appId	Application Id, Default is “aca”
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…
searchText	Search Strings
sortOrder	Results Sort Order (asc/desc)
mode	Default mode is ‘client’
logic	Logic is AND/OR
limit	Number of results

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X GET \
  'https://api.seic.com/v2/contentmanagement/files?appId=aca&searchText=test&sortBy=name' \
  -H 'Authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'AppKey: gsedgaerhDSHGRSH'

REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH

RESPONSE HEADER

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

SAMPLE RESPONSE

{
  "defaultIndicators": [
    "string"
  ],
  "results": [
    {
      "objectId": "string",
      "objectType": "string",
      "mimeType": "string",
      "nativeSize": "string",
      "renditionSize": "string",
      "properties": {
        "GRRC_userId": "string",
        "creator": "string",
        "sys_store-protocol": "string",
        "modifier": "string",
        "GRRC_date": "string",
        "GRRC_description": "string",
        "creationDate": "string",
        "Document": {
          "contentUrl": "string",
          "mimetype": "string",
          "size": "string",
          "encoding": "string",
          "locale": "string",
          "id": "string",
          "infoUrl": "string"
        },
        "title": "string",
        "sys_locale": "string",
        "cm_autoVersion": "string",
        "sys_store-identifier": "string",
        "cm_autoVersionOnUpdateProps": "string",
        "objectTypeReadOnly": "string",
        "versionLabel": "string",
        "cm_author": "string",
        "modifiedDate": "string",
        "objectName": "string",
        "cm_initialVersion": "string",
        "objectId": "string",
        "sys_node-dbid": "string"
      },
      "appliedAspects": "string"
    }
  ],
  "state": {
    "query_execute_time": "string",
    "limit_results": "string",
    "executedQuery": "string",
    "allowMaxPermChecks": "string",
    "query_parse_time": "string",
    "total_records": "string",
    "query_build_time": "string",
    "sort_by": "string",
    "total_pages": "string",
    "current_page": "string",
    "page_size": "string",
    "order": "string"
  },
  "searchParameters": [
    {
      "paramName": "string",
      "paramValue": "string",
      "paramType": "string",
      "operator": "string",
      "searchMod": "string",
      "termLogic": "string"
    }
  ],
  "facetFields": {},
  "parameterLogic": "string"
}

MODEL

Operations

Name	Description	Data Type (L)
createDate	Initial create timestamp for the record. Datetime is Eastern Standard Time (EST). Date Format is UTC YYYY-MM-DDThh:mm:ss:mmm	string
operator	Indicator that denotes whether the investor is a CPO as indicated on the subscription document.	boolean
order	A single mapping configuration can be a collection of individual processes. The Order field identifies the sequence in which each process should be run with 1 being first. This is useful when there is a data dependency across the processes in a single mapping configuration.	string
title	Gives the error/warning brief description	string

Retrieve Files

GET

/files

Returns Search Results - Searches files/documents in the content repository.

Prod:

https://api.seic.com/v2/contentmanagement/files

Query Parameters

Name	Description	Data Type
appId	Application Id, Default is “aca”	string
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing	string
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…	string
searchText	Search Strings	string
sortOrder	Results Sort Order (asc/desc)	string
mode	Default mode is ‘client’	string
logic	Logic is AND/OR	string
limit	Number of results	integer

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

appId	Application Id, Default is “aca”
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…
searchText	Search Strings
sortOrder	Results Sort Order (asc/desc)
mode	Default mode is ‘client’
logic	Logic is AND/OR
limit	Number of results

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Retrieve Files

GET

/files

Returns Search Results - Searches files/documents in the content repository.

Prod:

https://api.seic.com/v2/contentmanagement/files

Query Parameters

Name	Description	Data Type
appId	Application Id, Default is “aca”	string
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing	string
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…	string
searchText	Search Strings	string
sortOrder	Results Sort Order (asc/desc)	string
mode	Default mode is ‘client’	string
logic	Logic is AND/OR	string
limit	Number of results	integer

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

appId	Application Id, Default is “aca”
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…
searchText	Search Strings
sortOrder	Results Sort Order (asc/desc)
mode	Default mode is ‘client’
logic	Logic is AND/OR
limit	Number of results

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v2/contentmanagement/files

TLS*: https://mtls.api.seic.com/v2/contentmanagement/files

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 1

oAuthToken

POST

STEP 2

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

Retrieve Files

GET

/files

Returns Search Results - Searches files/documents in the content repository.

Prod:

https://api.seic.com/v2/contentmanagement/files

Query Parameters

Name	Description	Data Type
appId	Application Id, Default is “aca”	string
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing	string
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…	string
searchText	Search Strings	string
sortOrder	Results Sort Order (asc/desc)	string
mode	Default mode is ‘client’	string
logic	Logic is AND/OR	string
limit	Number of results	integer

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

appId	Application Id, Default is “aca”
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…
searchText	Search Strings
sortOrder	Results Sort Order (asc/desc)
mode	Default mode is ‘client’
logic	Logic is AND/OR
limit	Number of results

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X GET \
  'https://api.seic.com/v2/contentmanagement/files?appId=aca&searchText=test&sortBy=name' \
  -H 'Authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'AppKey: gsedgaerhDSHGRSH'

REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH

RESPONSE HEADER

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

SAMPLE RESPONSE

{
  "defaultIndicators": [
    "string"
  ],
  "results": [
    {
      "objectId": "string",
      "objectType": "string",
      "mimeType": "string",
      "nativeSize": "string",
      "renditionSize": "string",
      "properties": {
        "GRRC_userId": "string",
        "creator": "string",
        "sys_store-protocol": "string",
        "modifier": "string",
        "GRRC_date": "string",
        "GRRC_description": "string",
        "creationDate": "string",
        "Document": {
          "contentUrl": "string",
          "mimetype": "string",
          "size": "string",
          "encoding": "string",
          "locale": "string",
          "id": "string",
          "infoUrl": "string"
        },
        "title": "string",
        "sys_locale": "string",
        "cm_autoVersion": "string",
        "sys_store-identifier": "string",
        "cm_autoVersionOnUpdateProps": "string",
        "objectTypeReadOnly": "string",
        "versionLabel": "string",
        "cm_author": "string",
        "modifiedDate": "string",
        "objectName": "string",
        "cm_initialVersion": "string",
        "objectId": "string",
        "sys_node-dbid": "string"
      },
      "appliedAspects": "string"
    }
  ],
  "state": {
    "query_execute_time": "string",
    "limit_results": "string",
    "executedQuery": "string",
    "allowMaxPermChecks": "string",
    "query_parse_time": "string",
    "total_records": "string",
    "query_build_time": "string",
    "sort_by": "string",
    "total_pages": "string",
    "current_page": "string",
    "page_size": "string",
    "order": "string"
  },
  "searchParameters": [
    {
      "paramName": "string",
      "paramValue": "string",
      "paramType": "string",
      "operator": "string",
      "searchMod": "string",
      "termLogic": "string"
    }
  ],
  "facetFields": {},
  "parameterLogic": "string"
}

MODEL

Operations

Name	Description	Data Type (L)
createDate	Initial create timestamp for the record. Datetime is Eastern Standard Time (EST). Date Format is UTC YYYY-MM-DDThh:mm:ss:mmm	string
operator	Indicator that denotes whether the investor is a CPO as indicated on the subscription document.	boolean
order	A single mapping configuration can be a collection of individual processes. The Order field identifies the sequence in which each process should be run with 1 being first. This is useful when there is a data dependency across the processes in a single mapping configuration.	string
title	Gives the error/warning brief description	string

Retrieve Files

GET

/files

Returns Search Results - Searches files/documents in the content repository.

Prod:

https://api.seic.com/v2/contentmanagement/files

Query Parameters

Name	Description	Data Type
appId	Application Id, Default is “aca”	string
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing	string
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…	string
searchText	Search Strings	string
sortOrder	Results Sort Order (asc/desc)	string
mode	Default mode is ‘client’	string
logic	Logic is AND/OR	string
limit	Number of results	integer

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

appId	Application Id, Default is “aca”
searchConfigName	The searchConfigName parameter refers to one of the available ACA configurations for searching. The out of the box search offering searches against cm:document and cm:folder objects in Alfresco, the name of that configuration is “default”. As of now, we don’t foresee this changing
sortBy	Results are Sort by creationDate, modifiedDate,objectName,creator etc…
searchText	Search Strings
sortOrder	Results Sort Order (asc/desc)
mode	Default mode is ‘client’
logic	Logic is AND/OR
limit	Number of results

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

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...