5.5.2 Link type list acquisition

Description

Gets the list of types of link information applied to the system.

Execution permissions

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

API version

Format

Request line

GET /im/api/v1/links/types httpVersion

Response message body

{
    "linkTypes": [
    {
        "name":"type-of-link-information"
    }
}

Parameters

None

Status codes

The following table describes the status codes that are returned as a response to the request:

Status code	Message	Description
`200`	None	The list of link information types was retrieved successfully.
`403`	KAJY01000-E	There is no permission to run the REST API.

Return values

The following information is returned in the response body if the status code is 200:

No.	Member name		Data type	Description
1	`linkTypes`		Object[]	An array of link type objects
2		`name`	string	The SID of the preceding node

Example

Request:

GET /im/api/v1/links/types HTTP/1.1
Authorization:Bearer xxxx

Response:

HTTP/1.1 200 OK
Cache-Control: no-store, no-cache, max-age=0
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Content-Type: application/json
 
{
    "linkTypes": [
        {
            "name":"rootJobnetExecutionOrder"
        },
        {
            "name":"sameNode"
        },  ...
    ]
}

To Page Top