Jump to

• Request
• Response

Get the status of a specific system process.

get

/learn.rest/v1/systemProcesses/{id}

Request

Path Parameters

• id: string
  Unique identifier of a system process.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The system processes collection is fetched.

Body ()

Root Schema : SystemProcessResponse

Type: object

Object comprising the parameters returned when the system process collection is fetched.

Show Source

• enabledFlag(optional): boolean
  Specifies whether the system process is enabled.

  Example: true
• id(optional): string
  Id of the system process.

  Example: groupsync
• links(optional): array links
  Links to the system process.
• status(optional): string
  Specifies the status of the system process.

  Example: started

{
    "type":"object",
    "description":"Object comprising the parameters returned when the system process collection is fetched.",
    "properties":{
        "id":{
            "type":"string",
            "example":"groupsync",
            "description":"Id of the system process."
        },
        "enabledFlag":{
            "type":"boolean",
            "example":true,
            "description":"Specifies whether the system process is enabled."
        },
        "status":{
            "type":"string",
            "example":"started",
            "description":"Specifies the status of the system process."
        },
        "links":{
            "type":"array",
            "description":"Links to the system process.",
            "items":{
                "$ref":"#/definitions/SystemProcessLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Links to the system process.

Show Source

• Array of: object SystemProcessLink

{
    "type":"array",
    "description":"Links to the system process.",
    "items":{
        "$ref":"#/definitions/SystemProcessLink"
    }
}

Nested Schema : SystemProcessLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/systemProcesses/GroupSync
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/systemProcesses/GroupSync"
        }
    }
}

404 Response

Resource not found.

Back to Top