Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

Get enriched project indicator application

GET
/api/v2/projects/{projectId}/indicator-applications/{applicationId} 

       

        

         curl
          
         --request
          
         GET
          
         \
        

       

       

        

          
         --url
          
         https://localhost:10001/api/v2/projects/1/indicator-applications/example
          
         \
        

       

       

        

          
         --header
          
         '
         Authorization: 
          
         '

Retrieves one project indicator application by numeric ID or application UUID with full context

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectId
required
integer

Project ID

applicationId
required
string

Application ID or application UUID

Query Parameters

Section titled “Query Parameters ”
includeArchived
boolean

Include archived applications

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Enriched indicator application

Media type application/json
object
applicationUuid
string
controlCode
string
controlId
integer
controlTitle
string
createdAt
string
id
integer
indicator
object
createdAt
string
criteria
Array
object
declarationProfile
object
emitOn

“pass” | “fail” | “both” | “none”

string
Allowed values: pass fail both none
statementTemplate
string
titleTemplate
string
description
string
extractionRules
object
id
string
name
string
parameters
object
projectId
integer
provider
string
slug
string
tags
Array
triggerType
string
Allowed values: event
type
string
Allowed values: custom
updatedAt
string
usageCount
integer
indicatorId
string
lastEvaluatedAt
string
latestEvaluation
object
applicationId
integer
createdAt
string
criterionResults
Array
object
criteriaIndex
integer
field
string
reason
string
status
string
Allowed values: pass fail skipped
declarationIds
Array
durationMs
integer
evaluatedAt
string
extractedFields
object
failureDetails
Array
object
actualValue
arrayMatchMode
string
Allowed values: all any
criteriaIndex
integer
criteriaType
string
Allowed values: string number boolean date list[string] list[number]
elementPath
string
expectedValue
extractionPath
string
field
string
indexPath
Array
missing
boolean
operator
string
Allowed values: eq neq gt lt gte lte in notIn contains notContains
reason
string
failureReasons
Array
id
string
indicatorId
string
payloadHash
string
payloadTruncated
boolean
result
string
Allowed values: pass fail error awaiting_evaluation
triggerSource
string
projectId
integer
projectPolicyControlId
integer
projectPolicyId
integer
projectPolicyName
string
projectPolicySlug
string
status
string
Allowed values: active disabled archived
updatedAt
string
Example 

                                   

                                    

                                     {
                                    

                                   

                                   

                                    

                                      
                                     "indicator"
                                     : {
                                    

                                   

                                   

                                    

                                      
                                     "declarationProfile"
                                     : {
                                    

                                   

                                   

                                    

                                      
                                     "emitOn"
                                     : 
                                     "
                                     pass
                                     "
                                    

                                   

                                   

                                    

                                      
                                     },
                                    

                                   

                                   

                                    

                                      
                                     "triggerType"
                                     : 
                                     "
                                     event
                                     "
                                     ,
                                    

                                   

                                   

                                    

                                      
                                     "type"
                                     : 
                                     "
                                     custom
                                     "
                                    

                                   

                                   

                                    

                                      
                                     },
                                    

                                   

                                   

                                    

                                      
                                     "latestEvaluation"
                                     : {
                                    

                                   

                                   

                                    

                                      
                                     "criterionResults"
                                     : [
                                    

                                   

                                   

                                    

                                      
                                     {
                                    

                                   

                                   

                                    

                                      
                                     "status"
                                     : 
                                     "
                                     pass
                                     "
                                    

                                   

                                   

                                    

                                      
                                     }
                                    

                                   

                                   

                                    

                                      
                                     ],
                                    

                                   

                                   

                                    

                                      
                                     "failureDetails"
                                     : [
                                    

                                   

                                   

                                    

                                      
                                     {
                                    

                                   

                                   

                                    

                                      
                                     "arrayMatchMode"
                                     : 
                                     "
                                     all
                                     "
                                     ,
                                    

                                   

                                   

                                    

                                      
                                     "criteriaType"
                                     : 
                                     "
                                     string
                                     "
                                     ,
                                    

                                   

                                   

                                    

                                      
                                     "operator"
                                     : 
                                     "
                                     eq
                                     "
                                    

                                   

                                   

                                    

                                      
                                     }
                                    

                                   

                                   

                                    

                                      
                                     ],
                                    

                                   

                                   

                                    

                                      
                                     "result"
                                     : 
                                     "
                                     pass
                                     "
                                    

                                   

                                   

                                    

                                      
                                     },
                                    

                                   

                                   

                                    

                                      
                                     "status"
                                     : 
                                     "
                                     active
                                     "
                                    

                                   

                                   

                                    

                                     }

400

Section titled “400 ”

Bad request - Invalid application identifier

Media type application/json
object
key
additional properties
string
Example generated

                                       

                                        

                                         {
                                        

                                       

                                       

                                        

                                          
                                         "additionalProperty"
                                         : 
                                         "
                                         example
                                         "
                                        

                                       

                                       

                                        

                                         }

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json
object
key
additional properties
string
Example generated

                                       

                                        

                                         {
                                        

                                       

                                       

                                        

                                          
                                         "additionalProperty"
                                         : 
                                         "
                                         example
                                         "
                                        

                                       

                                       

                                        

                                         }

403

Section titled “403 ”

Forbidden - No project access or insufficient permissions

Media type application/json
object
key
additional properties
string
Example generated

                                       

                                        

                                         {
                                        

                                       

                                       

                                        

                                          
                                         "additionalProperty"
                                         : 
                                         "
                                         example
                                         "
                                        

                                       

                                       

                                        

                                         }

404

Section titled “404 ”

Indicator application not found

Media type application/json
object
key
additional properties
string
Example generated

                                       

                                        

                                         {
                                        

                                       

                                       

                                        

                                          
                                         "additionalProperty"
                                         : 
                                         "
                                         example
                                         "
                                        

                                       

                                       

                                        

                                         }

500

Section titled “500 ”

Internal server error

Media type application/json
object
key
additional properties
string
Example generated

                                       

                                        

                                         {
                                        

                                       

                                       

                                        

                                          
                                         "additionalProperty"
                                         : 
                                         "
                                         example
                                         "
                                        

                                       

                                       

                                        

                                         }