Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSchemaAnalysisRule

Retrieves a schema analysis rule.

Request Syntax


GET /collaborations/collaborationIdentifier/schemas/name/analysisRule/type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

collaborationIdentifier

A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

name

The name of the schema to retrieve the analysis rule for.

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?

Required: Yes

type

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

Valid Values: AGGREGATION | LIST | CUSTOM | ID_MAPPING_TABLE

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "analysisRule": { 
      "collaborationId": "string",
      "createTime": number,
      "name": "string",
      "policy": { ... },
      "type": "string",
      "updateTime": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

analysisRule

A specification about how data from the configured table can be used.

Type: AnalysisRule object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Caller does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400