Sticky F.A.Q.

API Reference > Pipes

  • 25 September 2023
  • 6 replies
  • 140 views
API Reference >  Pipes
Userlevel 7

Do you need help with your API queries and/or mutation?

Here are a few that might help you!😉


🔎Queries

📍LIST PIPES
{

pipes(ids: [ID1, ID2]) {

 id

 name

 phases {

  name

  cards (first: x) {

    edges {

    node { 

    id 

    title

     }

    }

   }

  }

 }

}

 

📍SHOW PIPE

{
 pipe(id: 123456) {
  id
  name
  start_form_fields {
   label
   id
 }
 labels {
  name
  id

}
 phases {
  name
  fields {
  label
  id
 }
  cards(first: X) {
   edges {
   node {
   id
   title

    }

    }

   }

  }

 }

}

 

📍SHOW ALL FIELDS FROM PIPE

{

  pipe(id: XXXXX) {

    start_form_fields {

      id

      internal_id

      label

      type

      options

    }

    phases {

      fields {

        label

        internal_id

        type

        options

      }

    }

  }

}


🛠Mutations

📍CREATE PIPE

mutation {
 createPipe(
 input: {
 organization_id: XXXX
 name: "XXXX"
 labels: [
 {name: "Label 01", color: "#FF0042"}
 ]
 members: [
 {user_id: 00000, role_name: "admin"}
 {user_id: 00001, role_name: "member"}
 ]
 phases: [
 {name: "First Step"}
 {name: "Finished", done: true}
 ]
 start_form_fields: [
 {type_id: "short_text", label: "Taks Name", editable: true}
 {type_id: "email", label: "Contact Email"}
 ]
 preferences: {
 inboxEmailEnabled: true
 }
 }
 ) {
 pipe {
 id
 name
 }
 }
}

📍UPDATE PIPE
mutation {
 updatePipe(
 input: {
 id: XXXXX
 icon: "emo"
 title_field_id: "contact_email"
 public: false
 public_form: true
 only_assignees_can_edit_cards: false
 anyone_can_create_card: true
 expiration_time_by_unit: 2
 expiration_unit: 86400
 }
 ) {
 pipe {
 id
 name
 }
 }
}

📍DELETE PIPE
mutation {
 deletePipe(input: { id: XXX }) {
 success
 }
}


6 replies

Userlevel 5
Badge

Hi @brennovn 

How are you? 😊
Could you please contact us by chat?
This makes communication easier, and we can better understand what you need, and help you in a more assertive way!

I look forward to hearing from you 😉
 

 

Userlevel 7

@Karine Cristina can you help us clarify this question, please?

Userlevel 4

Hi, Karine. Thanks for answering!

Just checking if I understood correctly because I was trying to use the createPipe request and your response was with the createPhaseField request. You are saying that today it is not possible to specify the connection when using the createPipe request  and I should make 2 requests: createPipe and createPhaseField afterwards?

Userlevel 5
Badge

Hi @brennovn , how are you? 😊


To indicate the pipe where you want to make the connection you can use this example:

 

mutation {
createPhaseField(
input: {phase_id: xxxxxxx, label: "NOVO CAMPO CONETADO", type: "connector", connectedRepoId: XXXXXXXXXXXX, canCreateNewConnected: true}
) {
phase_field {
id
label
}
}
}

 

You need to indicate the phase_id, the label, the type field which in this case is connector, and within the connection field we have a few variants:
connectedRepoId
canCreateNewConnected
canConnectExisting
canConnectMultiples

Here is the specification for each type of connector field:
 


If you need more information, we have this documentation to help you 😀

I think you'll be able to do what you need, but if you need something more specific, please contact our Pipefy support team!

See you 😉

Userlevel 4

Hi, Lais. How can I create a pipe with a connector field? I cannot understand how to specify the pipe in which I want to create the connection.

CREATE PIPE

mutation MyQuery {

  createPipe(

    input: {name: "API", organization_id: "000000000", phases: [{name: "A"}, {name: "B"}, {name: "C"}], start_form_fields: [{label: "Connector", type_id: "connector"}, {label: "Radio Horizontal", type_id: "radio_horizontal", options: ["Um", "Dois"]}]}

  ) {

    clientMutationId

  }

}

When I try the request above, I get the following response:

{     "data": {         "createPipe": null     },     "errors": [         {             "message": "Validation failed: Connected pipe can't be blank",             "locations": [                 {                     "line": 3,                     "column": 3                 }             ],             "path": [                 "createPipe"             ],             "code": 30003,             "type": "RecordInvalidError"         }     ] } 

Userlevel 7
Badge +18

Pipe's API is something I need to learn more about. It helps with a lot!

Reply