NodeWorkflowService

nodeWorkflowService Query

Audience: Programmer

Fetches a workflow-related object given its ID. This query follows the Relay Global Object Identification Specification and can retrieve any object that implements the NodeWorkflowService interface.

Arguments

Name	Type	Description
id	ID!	The unique identifier of the workflow object to retrieve

Return Type

NodeWorkflowService - An interface that returns an object implementing the NodeWorkflowService interface. This includes:

• Workflow - A Temporal workflow instance with execution details

• WorkflowSignal - A signal that can be sent to a running workflow

Usage Example

GraphQL Query

query GetWorkflowObject($id: ID!) {
  nodeWorkflowService(id: $id) {
    id
    ... on Workflow {
      workflowID
      runID
      workflowType
      status
      startTime
      endTime
      execution
      memo
      searchAttributes
      createdAt
      updatedAt
    }
    ... on WorkflowSignal {
      signalName
      workflowID
      runID
      payload
      status
      createdAt
      updatedAt
    }
  }
}

Query Variables

{
  "id": "V29ya2Zsb3c6MTIz"
}

JavaScript Example

const getWorkflowObject = async (objectId) => {
  const query = `
    query GetWorkflowObject($id: ID!) {
      nodeWorkflowService(id: $id) {
        id
        __typename
        ... on Workflow {
          workflowID
          runID
          workflowType
          status
          startTime
          endTime
          execution
        }
        ... on WorkflowSignal {
          signalName
          workflowID
          runID
          payload
          status
        }
      }
    }
  `;

  const response = await fetch('/graphql', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${accessToken}`
    },
    body: JSON.stringify({
      query,
      variables: { id: objectId }
    })
  });

  const { data } = await response.json();
  return data.nodeWorkflowService;
};

Type Detection

Use the __typename field to determine which specific type was returned:

const object = await getWorkflowObject(id);
switch (object.__typename) {
  case 'Workflow':
    console.log(`Workflow: ${object.workflowID} (${object.status})`);
    break;
  case 'WorkflowSignal':
    console.log(`Signal: ${object.signalName} for workflow ${object.workflowID}`);
    break;
}

Common Use Cases

Monitor Workflow Status

const checkWorkflowStatus = async (workflowId) => {
  const workflow = await getWorkflowObject(workflowId);
  if (workflow.__typename === 'Workflow') {
    return {
      id: workflow.workflowID,
      status: workflow.status,
      isRunning: workflow.status === 'Running',
      isCompleted: workflow.status === 'Completed',
      duration: workflow.endTime ? 
        new Date(workflow.endTime) - new Date(workflow.startTime) : null
    };
  }
};

Related

• NodeWorkflowService Interface

• Workflow Type

• WorkflowSignal Type

• Temporal Workflow Documentation