Chapter 6. TaskList

Chapter 6. TaskList
Prev		Next

Table of Contents

Scheduled Operations
Examples

Extract status information related to task operations from BDOM System

Generic reference:

/bdom/task/OPCODE/TASK_ID/STATUS/OBJECT/NAME/USER_ID/

Where:

OPCODE: operation type (STATUS)

TASK_ID: internal task id assigned by BDOM system

STATUS: task status(SUCCESS, PENDING_INT, FAILED_INT, PENDING_EXT, FAILED_EXT)

OBJECT: task type(DOMAIN)

NAME: domain name

USER_ID: your specific id assigned by BDOM system

Task Status codes:

SUCCESS - reserved for future use.

PENDING_INT - operation is waiting for an internal job to complete.

PENDING_EXT - operation is waiting for an external job to complete.

FAILED_INT - operation unsuccessful, job does not meet all internal validation criteria, also job can be on FAILED_INT if a dependency is on FAILED_EXT.

FAILED_EXT - operation usuccessful, job failed for external reasons(ex. registry).

Scheduled Operations

For all operations for which in xml request is available exec-date filed the actual execution for task will be delayed to date indicated by that field(exec-date)

Requests that supports scheduled operations:

Domain Hold

Domain Delete

Validation XSD:

Example 6.1. Task Validation XSD:

Name:Task.xsd

Source:

      
<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified">
    <xs:element name="request">
        <xs:complexType>
            <xs:all>
                <xs:element name="delete" minOccurs="0" maxOccurs="1">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="task_id" type="xs:int" maxOccurs="unbounded" />
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
</xs:schema>

Example 6.2. Get scheduled operations for a user

REQUEST:

Generic Operation: GET(http://backend.antagus.de/bdom/task/scheduled/-/-/-/-/13048/)

RESPONSE:

		

<multiresponse>
  <response>
    <class>RELAUNCH</class>
    <exec-date>2010-01-17</exec-date>
    <name>nic-domain-example.de</name>
    <object>domain</object>
    <opcode>delete</opcode>
    <task_id>3190159</task_id>
    <time>2009-03-18 18:10:10</time>
    <tld_id>7</tld_id>
    <type>COMPLEX</type>
  </response>

  <response>
    <class>RELAUNCH</class>
    <exec-date>2010-02-21</exec-date>
    <name>examples-nic-domain.de</name>
    <object>domain</object>
    <opcode>delete</opcode>
    <task_id>3315581</task_id>
    <time>2009-05-14 19:42:07</time>
    <tld_id>7</tld_id>
    <type>COMPLEX</type>
  </response>
</multiresponse>

Example 6.3. Delete scheduled operations for a user

REQUEST:

Generic Operation: POST(http://backend.antagus.de/bdom/task/delete/-/-/-/-/13048/,xml)

Where xml:

		
<?xml version="1.0" encoding="UTF-8"?>
<request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <delete>
        <task_id>3315581</task_id>
        <task_id>3190159</task_id>
    </delete>
</request>

RESPONSE:

		
<response>delete ok</response>

Examples

TaskList BDOM examples

Example 6.4. Get all tasks for user:

REQUEST:

Generic Operation: GET(http://backend.antagus.de/bdom/task/status/-/-/-/-/13048/)

RESPONSE:

        
<multiresponse>
  
  <response>
    <date>2009-01-20 21:07:56</date>
    <name>examples-nic-domain.de</name>
    <object>domain</object>
    <opcode>transfer-in</opcode>
    <status>PENDING_EXT</status>
    <task_id>3071767</task_id>
    <user_id>13048</user_id>
  </response>
  <response>
    <date>2009-02-27 17:09:50</date>
    <name>nic-domain-example.de</name>
    <object>domain</object>
    <opcode>transfer-in</opcode>
    <status>PENDING_EXT</status>
    <task_id>3151063</task_id>
    <user_id>13048</user_id>
  </response>
</multiresponse>

Example 6.5. Get info related to a single task:

REQUEST:

Generic Operation: GET(http://backend.antagus.de/bdom/task/status/3151063/-/-/-/13048/)

RESPONSE:

        
<response>
  <date>2009-02-27 17:09:50</date>
  <name>nic-domain-example.de</name>
  <object>domain</object>
  <opcode>transfer-in</opcode>
  <status>PENDING_EXT</status>
  <task_id>3151063</task_id>
  <user_id>13048</user_id>
</response>

Example 6.6. Get info related to a domain:

	Note
	Obs: to search by name, object must be supplied

REQUEST:

Generic Operation: GET(http://backend.antagus.de/bdom/task/status/-/-/domain/nic-domain-example.de/13048/)

RESPONSE:

        
<response>
  <date>2009-02-27 17:09:50</date>
  <name>nic-domain-example.de</name>
  <object>domain</object>
  <opcode>transfer-in</opcode>
  <status>PENDING_EXT</status>
  <task_id>3151063</task_id>
  <user_id>13048</user_id>
</response>

Example 6.7. Get info on all tasks with a certain STATUS:

	Note
	Obs: to search by name, object must be supplied

Generic Operation: GET(http://backend.antagus.de/bdom/task/status/-/PENDING_EXT/-/-/13048/)

        
<multiresponse>
  <response>
    <date>2009-01-20 21:07:56</date>
    <name>examples-nic-domain.de</name>
    <object>domain</object>
    <opcode>transfer-in</opcode>
    <status>PENDING_EXT</status>
    <task_id>3071767</task_id>
    <user_id>13048</user_id>
  </response>
  <response>
    <date>2009-02-27 17:09:50</date>
    <name>nic-domain-example.de</name>
    <object>domain</object>
    <opcode>transfer-in</opcode>
    <status>PENDING_EXT</status>
    <task_id>3151063</task_id>
    <user_id>13048</user_id>
  </response>
</multiresponse>

Prev		Next
Chapter 5. DnsZone	Home	Chapter 7. User