InstructionStatistics
Entity - Instruction Statistics - handles instruction statistics
Note for API version 8.0
As of API version 8.0, the visibility of the instructions is restricted in accordance to the Management Groups assigned to the users. See the note at the top of the Instructions page for an explanation of how this works. The same principle applies to the InstructionStatistics API, where it is not possible to access the statistics for an instruction if the instruction itself is not accessible.
Verb | Request | Notes | Permissions required |
|---|---|---|---|
GET | /Consumer/InstructionStatistics | Returns statistics for all instructions | It does not return Unauthorized (401) rather filters out instructions based on permissions. |
GET | /Consumer/InstructionStatistics/{id} | OBSOLETE from 3.3 (INC) onwards. Use /Consumer/InstructionStatistics/Summary/{id} instead Returns statistics for specific instruction | For questions
Returns Unauthorized (401) if user does not have the required permissions at global level or on the parent InstructionDefinition's product pack. |
GET | /Consumer/InstructionStatistics/Summary/{id} | Returns summarized statistics for specific instruction | For questions
Returns Unauthorized (401) if user does not have the required permissions at global level or on the parent InstructionDefinition's product pack. |
GET | /Consumer/InstructionStatistics/Detail/{id} | Returns detailed instruction statistics for specific instruction | For questions
Returns Unauthorized (401) if user does not have the required permissions at global level or on the parent InstructionDefinition's product pack. |
GET | /Consumer/InstructionStatistics/Combined/{id} | Returns summarized and detailed statistics for specific instruction | For questions
Returns Unauthorized (401) if user does not have the required permissions at global level or on the parent InstructionDefinition's product pack. |
POST | /Consumer/InstructionStatistics/Multiple | Minimum API version 8.0 Retrieves Statistics for multiple instructions. Input: list of instruction IDs, for example: [10, 45,18] Output: Array of InstructionStatistics objects. | The API is open to any caller, but the results returned will be filtered in accordance with the permissions and Management Groups of the caller. |