Provides access to several pattern graph images associated with Behavioral Assessments.
GET /behavioralassessments/{id}/patterns/{patternType}
Provides access to several pattern graph images associated with Behavioral Assessments.
Request
GET https://pi.predictiveindex.com/api/v1/behavioralassessments/<assessmentId>/patterns/<patternType>?format=<formatType>
Path Parameters
| Parameter | Type | Value | Required | Notes |
| assessmentId | string | The id of the assessment | Required | Determines which Behavioral Assessment's data to use for generating the report. |
| patternType | string or integer | The name or number of the report type | Required | Select one of several pattern types: 0 = Complete or Full - all three patterns 1 = Self pattern 2 = Self-Concept pattern 3 = Synthesis pattern |
Query Parameters
| Parameter | Type | Value | Required | Notes |
| format | string | The image file format | Required | The output image type: SVG or PNG |
Request Body
Response
Response Body
If successful, this method returns a 200 OK response code and the pattern image file in the response data stream.
Example Request
curl -X GET https://pi.predictiveindex.com/api/v1/behavioralassessments/abcd6001-9t12-4d48-87dd-bb8ef85y3q94/patterns/0?format=PNG \
-H "api-key: 12345678-ABCD-EFGH-1234-ABCDEFGH1234"
Example Response
N/A
When you use GET behavioralassessments/{id} to retrieve the full results from a Behavioral Assessment, there are two properties in the results that contain the full API method call for the two images most frequently requested:
"patternFullUrl": "https://pi.predictiveindex.com/api/v1/behavioralassessments/{assessmentId}/patterns/0?format=PNG",
"patternSelfUrl": "https://pi.predictiveindex.com/api/v1/behavioralassessments/{assessmentId}/patterns/1?format=PNG",
"patternFullUrl" contains the image with all three pattern graphs
"patternSelfUrl" contains only the Self pattern image
Developers can either use these properties from the method mentioned above or construct URLs like them to get the other two patterns by themselves by changing the pattern number:
0 = Full or Complete
1 = Self
2 = Self-Concept
3 = Synthesis
Science Note:PI generally shows the Self-Concept and Synthesis patterns in reports and in the software UI along with the Self pattern because the Self pattern says the most about a person's needs whereas the Synthesis and Self-Concept patterns reveal their adaptations to expectations. To get a more complete understanding of a person, the Self pattern is the most important of the three.