Synapse Dynamic HTTP API (v1)

Download OpenAPI specification:Download

The Dynamic Service HTTP API

Authenticator

/SaveSmartCardToken

Request Body schema:
application/json

userId	string or null
smartCardToken	string or null

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"smartCardToken": "string"
}

/RemoveSmartCardToken

query Parameters

userId

string

Responses

/GetSmartCardToken

query Parameters

userId

string

Responses

Response samples

200

Content type

text/plain

No sample

BaseView

/GetBaseViewList

Authorizations:

oauth2

query Parameters

baseviewname	string
orderby	string
limit	string
offset	string
filter	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetBaseViewListByAttribute

Authorizations:

oauth2

query Parameters

baseviewname	string
synapseattributename	string
attributevalue	string
orderby	string
limit	string
offset	string
filter	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetBaseViewListObjectByAttribute

Authorizations:

oauth2

query Parameters

baseviewname	string
synapseattributename	string
attributevalue	string
filter	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetBaseViewListByPost

Authorizations:

oauth2

query Parameters

baseviewname	string
orderby	string
limit	string
offset	string
filter	string

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200

Content type

text/plain

No sample

Dynamic

/GetList

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string
returnsystemattributes	string
orderby	string
limit	string
offset	string
filter	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetListByPost

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string
returnsystemattributes	string
orderby	string
limit	string
offset	string
filter	string

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200

Content type

text/plain

No sample

/GetObject

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string
id	string
returnsystemattributes	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetObjectWithInsert

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string
synapseattributename	string
attributevalue	string
keyvalue	string
returnsystemattributes	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetListByAttribute

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string
synapseattributename	string
attributevalue	string
returnsystemattributes	string
orderby	string
limit	string
offset	string
filter	string

Responses

Response samples

200

Content type

text/plain

No sample

/PostObject

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200

Content type

text/plain

No sample

/PostObjectArray

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200

Content type

text/plain

No sample

/PostObjectsInTransaction

Authorizations:

oauth2

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200

Content type

text/plain

No sample

/SynchronousPost

Authorizations:

oauth2

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

/GetSynchronousPostVersionNumber

Authorizations:

oauth2

query Parameters

personId	string
moduleName	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetSynchronousPostVersion

Authorizations:

oauth2

query Parameters

personId	string
moduleName	string

Responses

Response samples

200

Content type

text/plain

No sample

/DeleteObjectByAttribute

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string
synapseattributename	string
attributevalue	string

Responses

Response samples

200

Content type

text/plain

No sample

/DeleteObject

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string
id	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetObjectHistory

Authorizations:

oauth2

query Parameters

synapsenamespace	string
synapseentityname	string
id	string

Responses

Response samples

200

Content type

text/plain

No sample

IdentityDataConnector

/test

Authorizations:

oauth2

Responses

Response samples

200

Content type

text/plain

No sample

Interop

/GenerateInpatientTransferMessage

Authorizations:

oauth2

query Parameters

encounterId

string

Responses

Response samples

200

Content type

text/plain

No sample

List

/GetListColumns

Authorizations:

oauth2

query Parameters

listId

string

Responses

Response samples

200

Content type

text/plain

No sample

/GetListDetails

Authorizations:

oauth2

query Parameters

listId

string

Responses

Response samples

200

Content type

text/plain

No sample

/GetListData

Authorizations:

oauth2

query Parameters

listId

string

Responses

Response samples

200

Content type

text/plain

No sample

/GetListDataByPost

Authorizations:

oauth2

query Parameters

listId

string

Request Body schema:
application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200

Content type

text/plain

No sample

/GetListByLocatorBoardID

Authorizations:

oauth2

query Parameters

locatorboard_id

string

Responses

Response samples

200

Content type

text/plain

No sample

/GetListQuestions

Authorizations:

oauth2

query Parameters

listId	string
contextvalue	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetListPersonBanner

Authorizations:

oauth2

query Parameters

listId	string
contextvalue	string

Responses

Response samples

200

Content type

text/plain

No sample

/GetQuestionOptionCollection

Authorizations:

oauth2

query Parameters

questionoptioncollection_id

string

Responses

Response samples

200

Content type

text/plain

No sample

/GetListSnapshot

Authorizations:

oauth2

query Parameters

listId

string

Responses

Response samples

200

Content type

text/plain

No sample

/GetContext

Authorizations:

oauth2

query Parameters

defaultcontext	string
defaultcontextfield	string
value	string

Responses

Response samples

200

Content type

text/plain

No sample

MetaData

/GetUserPersona

Authorizations:

oauth2

Responses

Response samples

200

Content type

text/plain

No sample

Synapse Dynamic HTTP API (v1)

Authenticator

/SaveSmartCardToken

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

/RemoveSmartCardToken

query Parameters

Responses

/GetSmartCardToken

query Parameters

Responses

Response samples

BaseView

/GetBaseViewList

Authorizations:

query Parameters

Responses

Response samples

/GetBaseViewListByAttribute

Authorizations:

query Parameters

Responses

Response samples

/GetBaseViewListObjectByAttribute

Authorizations:

query Parameters

Responses

Response samples

/GetBaseViewListByPost

Authorizations:

query Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

Dynamic

/GetList

Authorizations:

query Parameters

Responses

Response samples

/GetListByPost

Authorizations:

query Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/GetObject

Authorizations:

query Parameters

Responses

Response samples

/GetObjectWithInsert

Authorizations:

query Parameters

Responses

Response samples

/GetListByAttribute

Authorizations:

query Parameters

Responses

Response samples

/PostObject

Authorizations:

query Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/PostObjectArray

Authorizations:

query Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

/PostObjectsInTransaction

Authorizations:

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json