{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sedna Authentication Job Reference API API",
    "version": "2019-01-01"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Job Reference API",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "getJobReferences",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference",
            "params": [
              {
                "name": "page[limit]",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[foreignKey]",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[type]",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[source]",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[name]",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[ids]",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[jobReferenceIds]",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[createdAt][since]",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[createdAt][until]",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Fetch a collection of job references\n\nRequired API Permissions: JOBREFERENCE_READ"
        },
        {
          "info": {
            "name": "createJobReference",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a job reference\n\nRequired API Permissions: JOBREFERENCE_WRITE"
        },
        {
          "info": {
            "name": "getJobReference",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Fetch a job reference\n\nRequired API Permissions: JOBREFERENCE_READ"
        },
        {
          "info": {
            "name": "updateJobReference",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a job reference\n\nRequired API Permissions: JOBREFERENCE_WRITE"
        },
        {
          "info": {
            "name": "deleteJobReference",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a job reference\n\nRequired API Permissions: JOBREFERENCE_DELETE"
        },
        {
          "info": {
            "name": "getMessagesWithJobReference",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/message",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query"
              },
              {
                "name": "fields[message]",
                "value": "",
                "type": "query",
                "description": "Comma separated list of fields to return. Please include only necessary fields for performance reasons. If this parameter is omitted, API will return all the fields and it can negatively impact the latency. Available fields: subject,snippet,fromName,fromEmail,bodyText,bodyHtml,hasAttachment,receivedAt,sentAt,messageId,inReplyTo,references,from,to,cc,bcc,signed. Id is always returned."
              }
            ]
          },
          "docs": "Fetches a collection of messages that have the given job reference applied. DEPRECATED: please use /{id}/messageV2 instead.\n\nRequired API Permissions: JOBREFERENCE_READ, MESSAGE_READ"
        },
        {
          "info": {
            "name": "getMessagesWithJobReferenceV2",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/messageV2",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "page[cursor]",
                "value": "",
                "type": "query",
                "description": "the next-page cursor returned as part of a previous call to this endpoint"
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query"
              },
              {
                "name": "fields[message]",
                "value": "",
                "type": "query",
                "description": "Comma separated list of fields to return. Please include only necessary fields for performance reasons. If this parameter is omitted, API will return all the fields and it can negatively impact the latency. Available fields: subject,snippet,fromName,fromEmail,bodyText,bodyHtml,hasAttachment,receivedAt,sentAt,messageId,inReplyTo,references,from,to,cc,bcc,signed. Id is always returned."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter[team]",
                "value": "",
                "type": "query",
                "description": "Comma separated list of teams to filter by. Only returns messages that belong to any of the specified teams. If omitted, messages belonging to all teams, including solo inboxes, are returned."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The value to sort the message by. Must be one of 'received_date' or 'activity'. Defaults to 'received_date' if not specified."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The order in which to sort the messages, i.e. 'desc' (newest messages first) or 'asc' (oldest messages first). Defaults to 'desc' if not specified."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Array of comma-separated relationships to retrieve entities for if they are present in the retrieved messages' relationships. e.g. 'comment,document,share,team,category,job_reference,assignment,keyword,address'"
              }
            ]
          },
          "docs": "Fetch a collection of messages that have the given job reference applied\n\nRequired API Permissions: JOBREFERENCE_READ, MESSAGE_READ"
        },
        {
          "info": {
            "name": "getJobReferenceMessageRelationships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/relationships/message",
            "params": [
              {
                "name": "page[limit]",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Fetch a job reference's message relationships. DEPRECATED: please use /{id}/messageV2 instead.\n\nRequired API Permissions: JOBREFERENCE_READ, MESSAGE_READ"
        },
        {
          "info": {
            "name": "addJobReferenceToMessages",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/relationships/message",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add messages to a job reference's message relationships\n\nRequired API Permissions: JOBREFERENCE_WRITE"
        },
        {
          "info": {
            "name": "removeJobReferenceFromMessages",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/relationships/message",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete messages from a job reference's message relationships\n\nRequired API Permissions: JOBREFERENCE_WRITE"
        },
        {
          "info": {
            "name": "getJobReferenceTeamRelationships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/relationships/team",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Fetch a job reference's team relationships\n\nRequired API Permissions: JOBREFERENCE_READ"
        },
        {
          "info": {
            "name": "addJobReferenceTeams",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/relationships/team",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add teams to a job reference's team relationships\n\nRequired API Permissions: JOBREFERENCE_WRITE"
        },
        {
          "info": {
            "name": "replaceJobReferenceTeams",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/relationships/team",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace teams in a job reference's team relationships\n\nRequired API Permissions: JOBREFERENCE_WRITE"
        },
        {
          "info": {
            "name": "deleteJobReferenceTeams",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/relationships/team",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Remove teams from a job reference's team relationships\n\nRequired API Permissions: JOBREFERENCE_WRITE"
        },
        {
          "info": {
            "name": "getJobReferenceUserRelationships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/relationships/user",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "filter[createdBy]",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Fetch a job reference's user relationships\n\nRequired API Permissions: JOBREFERENCE_READ"
        },
        {
          "info": {
            "name": "removeJobReferenceUserRelationships",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}.sednanetwork.com/platform/2019-01-01/job-reference/:id/relationships/user",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unsubscribe users from a job reference\n\nRequired API Permissions: JOBREFERENCE_WRITE"
        }
      ]
    }
  ],
  "bundled": true
}