Uses of Class
com.mypurecloud.sdk.v2.model.JsonSchemaDocument

Packages that use JsonSchemaDocument

Package	Description
com.mypurecloud.sdk.v2.api
com.mypurecloud.sdk.v2.model

Uses of JsonSchemaDocument in com.mypurecloud.sdk.v2.api

Methods in com.mypurecloud.sdk.v2.api that return JsonSchemaDocument

Modifier and Type	Method	Description
JsonSchemaDocument	IntegrationsApi.getIntegrationsActionDraftSchema(GetIntegrationsActionDraftSchemaRequest request)	Retrieve schema for a Draft based on filename.
JsonSchemaDocument	IntegrationsApi.getIntegrationsActionDraftSchema(String actionId, String fileName, Boolean flatten)	Retrieve schema for a Draft based on filename.
JsonSchemaDocument	IntegrationsApi.getIntegrationsActionSchema(GetIntegrationsActionSchemaRequest request)	Retrieve schema for an action based on filename.
JsonSchemaDocument	IntegrationsApi.getIntegrationsActionSchema(String actionId, String fileName, Boolean flatten)	Retrieve schema for an action based on filename.
JsonSchemaDocument	IntegrationsApi.getIntegrationsTypeConfigschema(GetIntegrationsTypeConfigschemaRequest request)	Get properties config schema for an integration type.
JsonSchemaDocument	IntegrationsApi.getIntegrationsTypeConfigschema(String typeId, String configType)	Get properties config schema for an integration type.

Methods in com.mypurecloud.sdk.v2.api that return types with arguments of type JsonSchemaDocument

Modifier and Type	Method	Description
ApiResponse<JsonSchemaDocument>	IntegrationsApi.getIntegrationsActionDraftSchema(ApiRequest<Void> request)	Retrieve schema for a Draft based on filename.
Future<JsonSchemaDocument>	IntegrationsApiAsync.getIntegrationsActionDraftSchemaAsync(GetIntegrationsActionDraftSchemaRequest request, AsyncApiCallback<JsonSchemaDocument> callback)	Retrieve schema for a Draft based on filename.
Future<ApiResponse<JsonSchemaDocument>>	IntegrationsApiAsync.getIntegrationsActionDraftSchemaAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<JsonSchemaDocument>> callback)	Retrieve schema for a Draft based on filename.
ApiResponse<JsonSchemaDocument>	IntegrationsApi.getIntegrationsActionDraftSchemaWithHttpInfo(String actionId, String fileName, Boolean flatten)	Retrieve schema for a Draft based on filename.
ApiResponse<JsonSchemaDocument>	IntegrationsApi.getIntegrationsActionSchema(ApiRequest<Void> request)	Retrieve schema for an action based on filename.
Future<JsonSchemaDocument>	IntegrationsApiAsync.getIntegrationsActionSchemaAsync(GetIntegrationsActionSchemaRequest request, AsyncApiCallback<JsonSchemaDocument> callback)	Retrieve schema for an action based on filename.
Future<ApiResponse<JsonSchemaDocument>>	IntegrationsApiAsync.getIntegrationsActionSchemaAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<JsonSchemaDocument>> callback)	Retrieve schema for an action based on filename.
ApiResponse<JsonSchemaDocument>	IntegrationsApi.getIntegrationsActionSchemaWithHttpInfo(String actionId, String fileName, Boolean flatten)	Retrieve schema for an action based on filename.
ApiResponse<JsonSchemaDocument>	IntegrationsApi.getIntegrationsTypeConfigschema(ApiRequest<Void> request)	Get properties config schema for an integration type.
Future<JsonSchemaDocument>	IntegrationsApiAsync.getIntegrationsTypeConfigschemaAsync(GetIntegrationsTypeConfigschemaRequest request, AsyncApiCallback<JsonSchemaDocument> callback)	Get properties config schema for an integration type.
Future<ApiResponse<JsonSchemaDocument>>	IntegrationsApiAsync.getIntegrationsTypeConfigschemaAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<JsonSchemaDocument>> callback)	Get properties config schema for an integration type.
ApiResponse<JsonSchemaDocument>	IntegrationsApi.getIntegrationsTypeConfigschemaWithHttpInfo(String typeId, String configType)	Get properties config schema for an integration type.

Method parameters in com.mypurecloud.sdk.v2.api with type arguments of type JsonSchemaDocument

Modifier and Type	Method	Description
Future<JsonSchemaDocument>	IntegrationsApiAsync.getIntegrationsActionDraftSchemaAsync(GetIntegrationsActionDraftSchemaRequest request, AsyncApiCallback<JsonSchemaDocument> callback)	Retrieve schema for a Draft based on filename.
Future<ApiResponse<JsonSchemaDocument>>	IntegrationsApiAsync.getIntegrationsActionDraftSchemaAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<JsonSchemaDocument>> callback)	Retrieve schema for a Draft based on filename.
Future<JsonSchemaDocument>	IntegrationsApiAsync.getIntegrationsActionSchemaAsync(GetIntegrationsActionSchemaRequest request, AsyncApiCallback<JsonSchemaDocument> callback)	Retrieve schema for an action based on filename.
Future<ApiResponse<JsonSchemaDocument>>	IntegrationsApiAsync.getIntegrationsActionSchemaAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<JsonSchemaDocument>> callback)	Retrieve schema for an action based on filename.
Future<JsonSchemaDocument>	IntegrationsApiAsync.getIntegrationsTypeConfigschemaAsync(GetIntegrationsTypeConfigschemaRequest request, AsyncApiCallback<JsonSchemaDocument> callback)	Get properties config schema for an integration type.
Future<ApiResponse<JsonSchemaDocument>>	IntegrationsApiAsync.getIntegrationsTypeConfigschemaAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<JsonSchemaDocument>> callback)	Get properties config schema for an integration type.

Uses of JsonSchemaDocument in com.mypurecloud.sdk.v2.model

Methods in com.mypurecloud.sdk.v2.model that return JsonSchemaDocument

Modifier and Type	Method	Description
JsonSchemaDocument	JsonSchemaDocument.additionalProperties(Object additionalProperties)
JsonSchemaDocument	JsonSchemaDocument.description(String description)
JsonSchemaDocument	ActionOutput.getErrorSchema()
JsonSchemaDocument	DecisionTableContract.getExecutionInputSchema()
JsonSchemaDocument	DecisionTableContract.getExecutionOutputSchema()
JsonSchemaDocument	ActionInput.getInputSchema()
JsonSchemaDocument	FlowDivisionView.getInputSchema()
JsonSchemaDocument	FlowVersion.getInputSchema()
JsonSchemaDocument	PostInputContract.getInputSchema()
JsonSchemaDocument	ActionInput.getInputSchemaFlattened()
JsonSchemaDocument	BusinessRulesDataSchema.getJsonSchema()
JsonSchemaDocument	DataSchema.getJsonSchema()
JsonSchemaDocument	JourneyEventDefinition.getJsonSchema()
JsonSchemaDocument	FlowDivisionView.getOutputSchema()
JsonSchemaDocument	FlowVersion.getOutputSchema()
JsonSchemaDocument	DecisionTableContract.getRowAuthoringSchema()
JsonSchemaDocument	DataTable.getSchema()
JsonSchemaDocument	FlattenedJsonSchemaDocument.getSchema()
JsonSchemaDocument	Response.getSubstitutionsSchema()
JsonSchemaDocument	ActionOutput.getSuccessSchema()
JsonSchemaDocument	PostOutputContract.getSuccessSchema()
JsonSchemaDocument	JsonSchemaDocument.id(String id)
JsonSchemaDocument	JsonSchemaDocument.properties(Map<String,Object> properties)
JsonSchemaDocument	JsonSchemaDocument.required(List<String> required)
JsonSchemaDocument	JsonSchemaDocument.schema(String schema)
JsonSchemaDocument	JsonSchemaDocument.title(String title)
JsonSchemaDocument	JsonSchemaDocument.type(String type)

Methods in com.mypurecloud.sdk.v2.model with parameters of type JsonSchemaDocument

Modifier and Type	Method	Description
ActionOutput	ActionOutput.errorSchema(JsonSchemaDocument errorSchema)	JSON schema that defines the body of response when request is not successful.
DecisionTableContract	DecisionTableContract.executionInputSchema(JsonSchemaDocument executionInputSchema)	JSON schema for execution input data for a decision table
DecisionTableContract	DecisionTableContract.executionOutputSchema(JsonSchemaDocument executionOutputSchema)	JSON schema for execution output data for a decision table
ActionInput	ActionInput.inputSchema(JsonSchemaDocument inputSchema)	JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path.
FlowDivisionView	FlowDivisionView.inputSchema(JsonSchemaDocument inputSchema)	json schema describing the inputs for the flow
FlowVersion	FlowVersion.inputSchema(JsonSchemaDocument inputSchema)
PostInputContract	PostInputContract.inputSchema(JsonSchemaDocument inputSchema)	JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path.
ActionInput	ActionInput.inputSchemaFlattened(JsonSchemaDocument inputSchemaFlattened)	JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path.
BusinessRulesDataSchema	BusinessRulesDataSchema.jsonSchema(JsonSchemaDocument jsonSchema)	A JSON schema defining the extension to the built-in entity type.
DataSchema	DataSchema.jsonSchema(JsonSchemaDocument jsonSchema)	A JSON schema defining the extension to the built-in entity type.
FlowDivisionView	FlowDivisionView.outputSchema(JsonSchemaDocument outputSchema)	json schema describing the outputs for the flow
FlowVersion	FlowVersion.outputSchema(JsonSchemaDocument outputSchema)
DecisionTableContract	DecisionTableContract.rowAuthoringSchema(JsonSchemaDocument rowAuthoringSchema)	JSON schema describing required value types for each column in every row in a decision table
DataTable	DataTable.schema(JsonSchemaDocument schema)	the schema as stored in the system.
FlattenedJsonSchemaDocument	FlattenedJsonSchemaDocument.schema(JsonSchemaDocument schema)
void	ActionOutput.setErrorSchema(JsonSchemaDocument errorSchema)
void	DecisionTableContract.setExecutionInputSchema(JsonSchemaDocument executionInputSchema)
void	DecisionTableContract.setExecutionOutputSchema(JsonSchemaDocument executionOutputSchema)
void	ActionInput.setInputSchema(JsonSchemaDocument inputSchema)
void	FlowDivisionView.setInputSchema(JsonSchemaDocument inputSchema)
void	FlowVersion.setInputSchema(JsonSchemaDocument inputSchema)
void	PostInputContract.setInputSchema(JsonSchemaDocument inputSchema)
void	ActionInput.setInputSchemaFlattened(JsonSchemaDocument inputSchemaFlattened)
void	BusinessRulesDataSchema.setJsonSchema(JsonSchemaDocument jsonSchema)
void	DataSchema.setJsonSchema(JsonSchemaDocument jsonSchema)
void	FlowDivisionView.setOutputSchema(JsonSchemaDocument outputSchema)
void	FlowVersion.setOutputSchema(JsonSchemaDocument outputSchema)
void	DecisionTableContract.setRowAuthoringSchema(JsonSchemaDocument rowAuthoringSchema)
void	DataTable.setSchema(JsonSchemaDocument schema)
void	FlattenedJsonSchemaDocument.setSchema(JsonSchemaDocument schema)
void	Response.setSubstitutionsSchema(JsonSchemaDocument substitutionsSchema)
void	ActionOutput.setSuccessSchema(JsonSchemaDocument successSchema)
void	PostOutputContract.setSuccessSchema(JsonSchemaDocument successSchema)
Response	Response.substitutionsSchema(JsonSchemaDocument substitutionsSchema)	Metadata about the text substitutions in json schema format.
ActionOutput	ActionOutput.successSchema(JsonSchemaDocument successSchema)	JSON schema that defines the transformed, successful result that will be sent back to the caller.
PostOutputContract	PostOutputContract.successSchema(JsonSchemaDocument successSchema)	JSON schema that defines the transformed, successful result that will be sent back to the caller.