.. meta::
    :description: This documentation will guide you through the use of the Memset API.

.. index::
   double: Methods; job

.. _job:

Job Methods
-----------

API interface for jobs

.. function:: job.status

    Reads the status of the job passed in.
    
    :param name: Name of the service - only show jobs that are attached to this service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
    :type name: String, Optional
    
    :param id: The Job ID. Job IDs are 32 hex digits.
    :type id: String
    
    :returns: A dictionary with the following keys:
    
        **id**
            String: job id (32 hex digits).
        **type**
            String: textual description of what the job is doing, e.g. "SETUP-NEW-MINISERVER".
        **status**
            String: some textual description of what the job is doing now.
        **service** (optional)
            String: The name of the service this is job is related to, if available.  Services don't have a name until they have been created.
        **finished**
            Boolean: set if job has finished.
        **error**
            Boolean: set if the job didn't finish properly or was cancelled.