Jump to

• Request
• Response

Get Full Neo4j Path for a Service

get

/api/SLM/Services/readPathFromServiceID

Gets the full path in Neo4j for the service specified by ServiceID.

Request

Query Parameters

• ServiceID(required): string
  The SLM service ID.

  Example:

  2de8190b-4bd8-4a2a-91ec-03e9fdae83e0

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The full path in Neo4j for the specified service.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "Path":{
                                "description":"The path from the root node",
                                "type":"string",
                                "example":"//Root/"
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The full path in Neo4j for the specified service.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The full path in Neo4j for the specified service.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Path":{
                        "description":"The path from the root node",
                        "type":"string",
                        "example":"//Root/"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: array

The full path in Neo4j for the specified service.

Show Source

• Array of: object items

{
    "description":"The full path in Neo4j for the specified service.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Path":{
                "description":"The path from the root node",
                "type":"string",
                "example":"//Root/"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Path: string
  The path from the root node

  Example: //Root/

{
    "type":"object",
    "properties":{
        "Path":{
            "description":"The path from the root node",
            "type":"string",
            "example":"//Root/"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top