Home
/
API reference
/
API documentation (JSON/XML)
/
Tasks
/
Job tasks

Workflow job info

API reference (XML/JSON) · Updated 2023-09-18

Function

The WorkflowJobInfo task inquires the data of a job.

Description

Can use the following objects

Route: GET/job/{id}
There is no need to send a body.

{
}

Example for a Domain Job Response

{
    "stid": "20190829-app2-dev-16923",
    "status": {
        "code": "S300114",
        "text": "The workflow order was inquired succesfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "ObjectJob",
        "value": "4297705675"
    },
    "data": [
        {
            "job": {
                "created": "2019-08-29T13:56:00.000+0200",
                "updated": "2019-08-29T13:55:59.000+0200",
                "owner": {
                    "context": 4,
                    "user": "customer"
                },
                "updater": {
                    "context": 4,
                    "user": "customer"
                },
                "status": "WAIT",
                "subStatus": "pending_spool_base",
                "execution": "2019-08-29T13:55:58.000+0200",
                "action": "create",
                "subType": "AU-TEST_au",
                "id": 4297705675
            },
            "object": {
                "type": "Domain",
                "value": "example.com.au",
                "data": {
                    "created": "2019-08-29T13:55:58.000+0200",
                    "owner": {},
                    "updater": {},
                    "name": "example.com.au",
                    "registryStatus": "ACTIVE",
                    "nameServers": [
                        {
                            "name": "ns1.example.com"
                        },
                        {
                            "name": "ns2.example.com"
                        }
                    ],
                    "period": {
                        "unit": "YEAR",
                        "period": 1
                    },
                    "confirmOrder": true,
                    "registrarStatus": "ACTIVE",
                    "rddsOptIn": "NOT_SET",
                    "ownerc": {
                        "id": 21642636
                    },
                    "techc": {
                        "id": 21642636
                    },
                    "adminc": {
                        "id": 21642636
                    },
                    "action": "CREATE",
                    "autoRenewStatus": "TRUE"
                }
            }
        }
    ]
}

Example for a Contact Job Response

{
    "stid": "20220627-app2-dev-13622",
    "status": {
        "code": "S300114",
        "text": "The workflow order was inquired succesfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "ObjectJob",
        "value": "4299693655"
    },
    "data": [
        {
            "job": {
                "created": "2021-03-02T14:06:41.000+0100",
                "updated": "2021-03-02T14:06:41.000+0100",
                "owner": {
                    "context": 4,
                    "user": "customer"
                },
                "updater": {
                    "context": 4,
                    "user": "customer"
                },
                "status": "WAIT",
                "subStatus": "pending_spool_base",
                "execution": "2021-03-02T14:06:41.000+0100",
                "subType": "",
                "action": "update",
                "id": 4299693655
            },
            "object": {
                "type": "Contact",
                "value": "23100441",
                "data": {
                    "created": "2018-09-18T15:31:27.000+0200",
                    "updated": "2021-03-02T14:06:41.000+0100",
                    "id": 23100441,
                    "alias": "Jane-Doe",
                    "type": "PERSON",
                    "organization": "InterNetX",
                    "title": "Dr.",
                    "city": "Regensburg",
                    "country": "DE",
                    "state": "DE",
                    "email": "test@email.com",
                    "protection": "SHOW_NONE",
                    "domainsafe": false,
                    "fname": "Jane",
                    "lname": "Doe",
                    "address": [
                        "Plasmaweg 21"
                    ],
                    "pcode": "93047",
                    "phone": "+49-176-22567941",
                    "nicRef": [
                        {
                            "nic": {
                                "label": "DONUTS-TEST",
                                "name": "dating"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "CENTRALNIC-TEST",
                                "name": "de"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "DE-TEST",
                                "name": "de"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "DONUTS-TEST",
                                "name": "exposed"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "DONUTS-TEST",
                                "name": "fish"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "NEW-TEST",
                                "name": "new"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "PIR-TEST",
                                "name": "org"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "PARTY-TEST",
                                "name": "party"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "CENTRALNIC-TEST",
                                "name": "store"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "UK-TEST",
                                "name": "uk"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        },
                        {
                            "nic": {
                                "label": "DONUTS-TEST",
                                "name": "zone"
                            },
                            "type": "ALL",
                            "role": "ALL"
                        }
                    ]
                }
            }
        }
    ]
}