Get All Published AP Is

Get All Published AP Is

Retrieves all the service APIs published by the given API Publishing Function.

Request
URI
GET
https://{api_host}/dms/published-apis/v1/{apfId}/service-apis
COPY
Path Parameters
string
apfId
Required

ID of the API Publishing Function.

Header Parameters
string
Version
Optional

If provided in a request, the value of the header is a string signalling the desired version of the API to be used in handling the request. If the provided version is not available, a 406 Not Acceptable response will be sent. If no Version header is provided, the latest available version will be used. This mechanism allows a user-agent to request a specfic version of the API when multiple versions are available.

Responses
200

Definition of all service API(s) published by the API publishing function.

Returns Array of ServiceAPIDescription of type(s) application/json 
[
    {
        "apiName": "string",
        "apiId": "string",
        "aefProfiles": [
            {
                "aefId": "string",
                "versions": [
                    {
                        "apiVersion": "string",
                        "expiry": "string",
                        "resources": [
                            {
                                "resourceName": "string",
                                "uri": "string",
                                "custOpName": "string",
                                "operations": [
                                    {}
                                ],
                                "description": "string"
                            }
                        ],
                        "custOperations": [
                            {
                                "custOpName": "string",
                                "operations": [
                                    {}
                                ],
                                "description": "string"
                            }
                        ]
                    }
                ],
                "securityMethods": [
                    {}
                ],
                "domainName": "string",
                "interfaceDescriptions": [
                    {
                        "ipv4Addr": "string",
                        "ipv6Addr": "string",
                        "fqdn": "string",
                        "port": 0,
                        "apiPrefix": "string",
                        "securityMethods": [
                            {}
                        ]
                    }
                ]
            }
        ],
        "description": "string",
        "supportedFeatures": "string",
        "shareableInfo": {
            "isShareable": false,
            "capifProvDoms": [
                "string"
            ]
        },
        "serviceAPICategory": "string",
        "apiSuppFeats": "string",
        "pubApiPath": {
            "ccfIds": [
                "string"
            ]
        },
        "ccfId": "string"
    }
]

Response Headers

string
Version

The Version header in a response indicates the version of the API used to handle this request-response pair, in an API which has the potential to support multiple versions. Different versions may be requested using a Version header in a request.


400
Returns BadRequest of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


401
Returns Unauthorized of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


403
Returns Forbidden of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


404
Returns NotFound of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


406
Returns Unacceptable of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


500
Returns ServerError of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


503
Returns ServiceUnavailable of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


On This Page
Api Publishing Operations
DELETE
Delete Published API By Id
GET
Get All Published AP Is
GET
Get Published API By Id
PUT
Modify Published API By Id
POST
Publish New API
PATCH
Update Published API By Id