Jump to

• Request
• Response
• Examples

Gets the List of All Recon Jobs

get

/iam/governance/applicationmanagement/api/v1/applications/{appId}/jobs

Returns all the recon jobs for a given application.

Request

Path Parameters

• appId: string
  Name of the application

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ReconJobDetail

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ReconJobDetail"
    }
}

Nested Schema : ReconJobDetail

Type: object

Show Source

• jobName(optional): string
• mode(optional): string
  Allowed Values: [ "Full", "Incremental", "Delete", "Entitlement", "Flat File Full", "Flat File Diff Sync", "Flat File Delete Sync", "Flat File Entitlement", "Flat File Delete" ]
• parameter(optional): array parametersList

{
    "type":"object",
    "properties":{
        "jobName":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "mode":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "Full",
                "Incremental",
                "Delete",
                "Entitlement",
                "Flat File Full",
                "Flat File Diff Sync",
                "Flat File Delete Sync",
                "Flat File Entitlement",
                "Flat File Delete"
            ]
        },
        "parameter":{
            "type":"array",
            "xml":{
                "name":"parametersList",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/ReconJobParameter"
            }
        }
    }
}

Nested Schema : parametersList

Type: array

Show Source

• Array of: object ReconJobParameter

{
    "type":"array",
    "xml":{
        "name":"parametersList",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/ReconJobParameter"
    }
}

Nested Schema : ReconJobParameter

Type: object

Show Source

• dataType(optional): string
  Allowed Values: [ "String", "Number", "Boolean", "ITResource" ]
• encrypted(optional): boolean
  Default Value: false
• helpText(optional): string
• name(optional): string
• required(optional): boolean
  Default Value: false
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "value":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "helpText":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "dataType":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "String",
                "Number",
                "Boolean",
                "ITResource"
            ]
        },
        "required":{
            "type":"boolean",
            "xml":{
                "attribute":true
            },
            "default":false
        },
        "encrypted":{
            "type":"boolean",
            "xml":{
                "attribute":true
            },
            "default":false
        }
    }
}

Back to Top

Examples

cURL Example

This example demonstrates the ability to return all the recon jobs for a given application. The information shown here is against a pseudo system and serves as a prototype.

curl -X GET http://pseudo.com/iam/governance/applicationmanagement/api/v1/applications/db2/jobs

Response Body Example

[  
   {  
      "jobName":"db2 Target Recon Job",
      "mode":"Full",
      "parametersList":{  
         "parameter":[  
            {  
               "name":"Application Name",
               "value":"db",
               "helpText":"Application Name",
               "dataType":"String"
            },
            {  
               "name":"Filter",
               "value":"",
               "helpText":"Filter",
               "dataType":"String"
            },
            {  
               "name":"Object Type",
               "value":"User",
               "helpText":"Object Type",
               "dataType":"String"
            }
         ]
      }
   },
   {  
      "jobName":"db2 Target Incremental Recon Job",
      "mode":"Incremental",
      "parametersList":{  
         "parameter":[  
            {  
               "name":"Application Name",
               "value":"db2",
               "helpText":"Application Name",
               "dataType":"String"
            },
            {  
               "name":"Scheduled Task Name",
               "value":"db2 Target Incremental Recon Job",
               "helpText":"Scheduled Task Name",
               "dataType":"String"
            },
            {  
               "name":"Sync Token",
               "value":"set Sync Token",
               "helpText":"Sync Token",
               "dataType":"String"
            },
            {  
               "name":"Object Type",
               "value":"User",
               "helpText":"Object Type",
               "dataType":"String"
            }
         ]
      }
   },
   {  
      "jobName":"db2 Entitlement Loader Job",
      "mode":"Entitlement",
      "parametersList":{  
         "parameter":[  
            {  
               "name":"Lookup Name",
               "value":"Lookup.Expense.Roles",
               "helpText":"Lookup Name",
               "dataType":"String",
               "required":true
            },
            {  
               "name":"Code Key Attribute",
               "value":"EXPENSE_ROLES.ROLEID",
               "helpText":"Code Key Attribute",
               "dataType":"String",
               "required":true
            },
            {  
               "name":"Decode Attribute",
               "value":"EXPENSE_ROLES.ROLENAME",
               "helpText":"Decode Attribute",
               "dataType":"String",
               "required":true
            },
            {  
               "name":"Object Type",
               "value":"Other",
               "helpText":"Object Type",
               "dataType":"String",
               "required":true
            },
            {  
               "name":"Application Name",
               "value":"db2",
               "helpText":"Application Name",
               "dataType":"String",
               "required":false
            }
         ]
      }
   },
   {  
      "jobName":"ConnectorJob",
      "mode":"Full",
      "parametersList":{  
         "parameter":[  
            {  
               "name":"Object Type",
               "value":"User",
               "helpText":"Object Type",
               "dataType":"String",
               "required":true
            },
            {  
               "name":"Application Name",
               "value":"db2",
               "helpText":"Application Name",
               "dataType":"String",
               "required":true
            }
         ]
      }
   }
]

Back to Top