Get Incident Progress Trail By Number with TOPdesk API

Pipedream makes it easy to connect APIs for TOPdesk and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Incident Progress Trail By Number with the TOPdesk API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Incident Progress Trail By Number with the TOPdesk API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Incident Progress Trail By Number action
1. Connect your TOPdesk account
2. Select a Incident Number
3. Optional- Configure Max Results
4. Optional- Configure Inline Images
5. Optional- Configure Force Images As Data
6. Optional- Configure Non API Attachment URLs
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Incident Progress Trail By Number on TOPdesk

Description:Get incident progress trail by incident number. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/progress%20trail%20%2F%20actions%20%2F%20requests/getIncidentProgressTrailByNumber)

Version:0.0.1

Key:topdesk-get-incident-progress-trail-by-number

View on GitHub

Code#

import app from "../../topdesk.app.mjs";

export default {
  key: "topdesk-get-incident-progress-trail-by-number",
  name: "Get Incident Progress Trail By Number",
  description: "Get incident progress trail by incident number. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/progress%20trail%20%2F%20actions%20%2F%20requests/getIncidentProgressTrailByNumber)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    incidentNumber: {
      label: "Incident Number",
      description: "The number of the incident",
      propDefinition: [
        app,
        "incidentId",
        () => ({
          mapper: (incident) => ({
            label: incident.briefDescription
              ? `${incident.number} - ${incident.briefDescription}`
              : incident.number,
            value: incident.number,
          }),
        }),
      ],
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "Maximum number of progress trail entries to return",
      optional: true,
    },
    inlineImages: {
      propDefinition: [
        app,
        "inlineImages",
      ],
    },
    forceImagesAsData: {
      propDefinition: [
        app,
        "forceImagesAsData",
      ],
    },
    nonApiAttachmentUrls: {
      propDefinition: [
        app,
        "nonApiAttachmentUrls",
      ],
    },
  },
  annotations: {
    readOnlyHint: true,
    destructiveHint: false,
    openWorldHint: true,
  },
  async run({ $ }) {
    const {
      app,
      incidentNumber,
      maxResults,
      inlineImages,
      forceImagesAsData,
      nonApiAttachmentUrls,
    } = this;

    const results = [];

    const paginator = app.paginate({
      fn: app.getIncidentProgressTrailByNumber,
      fnArgs: {
        $,
        number: incidentNumber,
        params: {
          inlineimages: inlineImages,
          force_images_as_data: forceImagesAsData,
          non_api_attachment_urls: nonApiAttachmentUrls,
        },
      },
      maxResults,
    });

    for await (const entry of paginator) {
      results.push(entry);
    }

    $.export("$summary", `Successfully retrieved ${results.length} progress trail entr${results.length === 1
      ? "y"
      : "ies"} for incident number \`${incidentNumber}\``);

    return results;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
TOPdesk	`app`	`app`	This component uses the TOPdesk app.
Incident Number	`incidentNumber`	`string`	Select a value from the drop down menu.
Max Results	`maxResults`	`integer`	Maximum number of progress trail entries to return
Inline Images	`inlineImages`	`boolean`	Whether inline images should be returned
Force Images As Data	`forceImagesAsData`	`boolean`	Whether imageData should be forced to be returned as Base64 inline images instead of a URL. Only taken into account when inlineImages is true.
Non API Attachment URLs	`nonApiAttachmentUrls`	`boolean`	Whether links to attachments and bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user