API config API

The API config API call allows you to:

• Add an API config
• Delete an API config
• List all pending add or delete API config operations

Note: The nsfilter (namespace filter) query parameter is mandatory for every request. It sets the context, helping you look up resources within that namespace. Example: GET /apiconfigdefs?nsfilter=proj_DrZrSNrW

Add API Config

Endpoint

POST /objectmodelsvc/api/v1/apiconfigdefs

Parameters

Query

Parameter	Type	Description	Required
nsfilter	String	Enter a namespace or multiple namespaces in comma separated string.	Required

Body

Parameter	Type	Description	Required
_configItemId	String	Config Item Id for the config stored in the Item Service.	Optional

{
  "_configItemId": "60af0d1872470f44d27c6cc3"
}

Response

Codes

Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
409	Conflict

Body

{
   "_timetaken": 0.169,
   "_result": "API config added successfully & reloaded all the available api gateway instances!!"
}

Delete API Config

Endpoint

DELETE /objectmodelsvc/api/v1/apiconfigdefs

Parameters

Query

Parameter	Type	Description	Required
nsfilter	String	Enter a namespace or multiple namespaces in comma separated string.	Required

Response

Codes

Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found

Body

{
    "_timetaken": 0.021,
    "_result": "API config deleted successfully & reloaded all the available api gateway instances!!"
}

List all Pending Add or Delete Configs

Endpoint

GET /objectmodelsvc/api/v1/apiconfigdefs

Parameters

Query

Parameter	Type	Description	Required
nsfilter	String	Enter a namespace or multiple namespaces in comma separated string.	Required
_isconfigadded	Boolean	To list all pending add configs, set this to true and set _tobedeleted to false.	Optional
_tobedeleted	Boolean	To list all pending delete configs, set this to true and set _isconfigadded to false.	Optional

Response

Codes

Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found

Body

{
    "_timetaken": 0.046,
    "_result": [
        {
            "id": "7d9aba9d-5d56-48eb-9be0-e4ba98f8586f",
            "_name": "DatasourceTest1_m63N2yoR",
            "_description": null,
            "_namespace": "DatasourceTest1_m63N2yoR",
            "_inputconfig": {...},
            "_data": {...},
            "_createdby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
            "_createdat": "1630298766047",
            "_updatedby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
            "_updatedat": "1630298766047",
            "_isconfigadded": false,
            "_tobedeleted": false
        }
    ]
}