Jump to

• Request
• Response
• Examples

Generates metadata for application configuration

put

/iam/governance/applicationmanagement/api/v1/applications/metadata

reconSituations - List of Reconciliation Situations. reconResponses - List of Reconciliation Responses. reconJobModes - List of Job Modes. jobParamDataTypes - List of support data types for Job's parameters. EntitlementTypeJobReqParams - List of Required Parameters for Entitlement Mode type Reconciliation Job. DeleteTypeJobReqParams - List of Required Parameters for Delete Mode type Reconciliation Job. IncrementalTypeJobReqParams - List of Required Parameters for Incremental Mode type Reconciliation Job. fullTypeJobReqParams - List of Required Parameters for Full Mode type Reconciliation Job. ruleElementOperator - List of Rule Element Operator related to Reconciliation Corelation Rule. ruleOperator - List of rule operator related to Reconciliation Corelation Rule. catalogRiskLevelCodeDecodeValueSet - List of catalog Risk Levels. advanceFlags - Writeback, Lookup, Date values for a schema attribute

Request

There are no request parameters for this operation.

Back to Top

Response

200 Response

successful operation

Body ()

Root Schema : ApplicationUIMetadata

Type: object

Show Source

• advanceFlags(optional): array advanceFlags
• catalogRiskLevelCodeDecodeValueSet(optional): array catalogRiskLevelCodeDecodeValueSet
• dataTypes(optional): array dataTypes
• deleteTypeJobReqParams(optional): array deleteTypeJobReqParams
• entitlementTypeJobReqParams(optional): array entitlementTypeJobReqParams
• fullTypeJobReqParams(optional): array fullTypeJobReqParams
• identityuserattributes(optional): array identityuserattributes
• incrementalTypeJobReqParams(optional): array incrementalTypeJobReqParams
• jobParamDataTypes(optional): array jobParamDataTypes
• reconJobModes(optional): array reconJobModes
• reconResponses(optional): array reconResponses
• reconSituations(optional): array reconSituations
• ruleElementOperator(optional): array ruleElementOperator
• ruleOperator(optional): array ruleOperator

{
    "type":"object",
    "properties":{
        "reconSituations":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reconResponses":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reconJobModes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "advanceFlags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "jobParamDataTypes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "identityuserattributes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "fullTypeJobReqParams":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconJobParameter"
            }
        },
        "ruleElementOperator":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ruleOperator":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "catalogRiskLevelCodeDecodeValueSet":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LookupValue"
            }
        },
        "dataTypes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "incrementalTypeJobReqParams":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconJobParameter"
            }
        },
        "deleteTypeJobReqParams":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconJobParameter"
            }
        },
        "entitlementTypeJobReqParams":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconJobParameter"
            }
        }
    }
}

Nested Schema : advanceFlags

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : catalogRiskLevelCodeDecodeValueSet

Type: array

Show Source

• [0]: object LookupValue

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

Nested Schema : dataTypes

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : deleteTypeJobReqParams

Type: array

Show Source

• [0]: object ReconJobParameter

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

Nested Schema : entitlementTypeJobReqParams

Type: array

Show Source

• [0]: object ReconJobParameter

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

Nested Schema : fullTypeJobReqParams

Type: array

Show Source

• [0]: object ReconJobParameter

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

Nested Schema : identityuserattributes

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : incrementalTypeJobReqParams

Type: array

Show Source

• [0]: object ReconJobParameter

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

Nested Schema : jobParamDataTypes

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : reconJobModes

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : reconResponses

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : reconSituations

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ruleElementOperator

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ruleOperator

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : LookupValue

Type: object

Show Source

• decodeValue(optional): string
• encodeValue(optional): string

{
    "type":"object",
    "properties":{
        "encodeValue":{
            "type":"string"
        },
        "decodeValue":{
            "type":"string"
        }
    }
}

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

This example demonstrates the method of generating metadata for application configuration. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -H "X-Requested-By: <anyvalue>"  -X PUT  -u username:password  https://pseudo.com/iam/governance/applicationmanagement/api/v1/applications/metadata

Back to Top