Request Structure
URL: /certificate/attribute
Type: POST
| Name | Param Type | Description | Field Type | Constraints |
|---|---|---|---|---|
sessionId
|
Header | Session Id received after login. |
String
|
Required if username and
password are not provided. |
username
|
Header | AppViewX login username. |
String
|
Required if sessionId is not
provided. |
password
|
Header | AppViewX login password. |
String
|
Required if sessionId is not
provided. |
Content-Type
|
Header | Specifies the nature of the data in the payload. |
String
|
Value of the param should be ‘application/json’. |
gwkey
|
Query | Tenant Key. This is needed only in case of multi tenant installations and can be ignored in other type of installations. |
String
|
NA |
gwsource
|
Query | Source from which the request is triggered (E.g. external) |
String
|
NA |
Payload
|
Body | Contains all the params to be sent in the request body for the post request. |
Payload
|
NA |
Payload
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
| Yes | List of the certificate attributes. |
Array ofAttribute
|
Array cannot be empty. At Least one entry should be added. |
Attribute
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
name
|
Yes | Name of the custom attribute. |
String
|
Must not start with special characters. No special characters except -, _ are allowed. |
label
|
Yes | Label to be shown in the UI for the custom attribute. |
String
|
Must not start with special characters. No special characters except -, _ are allowed. |
value
|
No | Default value for the attribute. |
String
|
NA |
mandatory
|
No | Specifies whether the attribute is mandatory or not. |
Boolean
|
NA |
helpInfo
|
No | Help info about the field. |
String
|
NA |