Preview: V3 Create Pipeline View

post

https://api.elliemae.com/encompass/v3/users/me/views/pipelineViews

Create User Pipeline view.

Currently available in Preview Mode only.

📘
Note:

API endpoints published in Preview mode are not supported for production use

Preview the API contract (including request and response samples) and provide feedback before the contract becomes official in the upcoming months

API Previews are intended for planning and feedback purpose only

Postman samples are not published for API Previews

Send us your suggestions for improving this API!

Tell us about your thoughts on the API Preview content

Does the content supporting API Previews provide you enough information to get a head start in planning for integration? Is it helpful?

What do you plan to use this API for?

Anything blocking you from using this API once it's production ready?

Are there any additions or features you would find useful?

Email us with your feedback: [email protected]

Body Params

string

A unique identifier of the Pipeline View.

orgType

string

Organization type. Enums: Internal, Tpo

tpoId

object

For TPO views as defined in the EntityReferenceContract. Requires orgType be provided as Tpo.
TpoId should be a valid Id for the user creating the pipeline user view.

name

string

Name of the Pipeline View. It is a required property for creating the Pipeline user view.

viewType

string

RetrieveOnly. Enums: UserView, PersonaView

loanFolderSelectionType

string

The loan folder selection type. Enums: AllFolders, AllActiveFolders, AllArchiveFolders, SelectedFolders

loanFolders

array of objects

To select individual folders, SelectedFolders must be provided in loanFolderSelectionType.
Unique list of folders. User should have access for passed list of loan folders, however if they do not have access, the user will still not be able to view those folders.

loanFolders

loanOwnership

string

Loan ownership. Enums: Allloans, MyLoans

RetrieveOnly

string

RetrieveOnly.

filter

object

Filter criteria to generate loans included in Pipeline View as defined in the QueryCriterionContract.
Filter definitions should be valid against canonical names.

columns

array of objects

Columns to be displayed in Pipeline View as defined in the PipelineViewColumnContract.
At least one column should be passed. Column definitions should be valid against canonical names and must be unique values.

columns

Headers

Authorization

string

required

Bearer token.

Responses

400

Bad Request

Language

URL

Loading…

Response

Choose an example:

application/json

200OK