Creates a project for the authenticated service provider.

POST

projects

curl --request POST \
  --url https://api.usw.gorelo.io/v1/projects \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Title": "Office 365 migration",
  "ClientId": 123,
  "LocationId": 123,
  "TypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "GroupId": 101,
  "Description": "<string>",
  "LeadAssigneeId": 123,
  "TagIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "WatcherIds": [
    123
  ],
  "SharedWithContactIds": [
    123
  ],
  "TargetDate": "2023-11-07T05:31:56Z",
  "CreatedByName": "<string>",
  "CreatedOn": "2023-11-07T05:31:56Z",
  "UpdatedOn": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/projects"

payload = {
    "Title": "Office 365 migration",
    "ClientId": 123,
    "LocationId": 123,
    "TypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "GroupId": 101,
    "Description": "<string>",
    "LeadAssigneeId": 123,
    "TagIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "WatcherIds": [123],
    "SharedWithContactIds": [123],
    "TargetDate": "2023-11-07T05:31:56Z",
    "CreatedByName": "<string>",
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdatedOn": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Title: 'Office 365 migration',
    ClientId: 123,
    LocationId: 123,
    TypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    GroupId: 101,
    Description: '<string>',
    LeadAssigneeId: 123,
    TagIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    WatcherIds: [123],
    SharedWithContactIds: [123],
    TargetDate: '2023-11-07T05:31:56Z',
    CreatedByName: '<string>',
    CreatedOn: '2023-11-07T05:31:56Z',
    UpdatedOn: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.usw.gorelo.io/v1/projects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/projects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Title' => 'Office 365 migration',
    'ClientId' => 123,
    'LocationId' => 123,
    'TypeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'GroupId' => 101,
    'Description' => '<string>',
    'LeadAssigneeId' => 123,
    'TagIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'WatcherIds' => [
        123
    ],
    'SharedWithContactIds' => [
        123
    ],
    'TargetDate' => '2023-11-07T05:31:56Z',
    'CreatedByName' => '<string>',
    'CreatedOn' => '2023-11-07T05:31:56Z',
    'UpdatedOn' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/projects"

	payload := strings.NewReader("{\n  \"Title\": \"Office 365 migration\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"GroupId\": 101,\n  \"Description\": \"<string>\",\n  \"LeadAssigneeId\": 123,\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"WatcherIds\": [\n    123\n  ],\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedOn\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usw.gorelo.io/v1/projects")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Title\": \"Office 365 migration\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"GroupId\": 101,\n  \"Description\": \"<string>\",\n  \"LeadAssigneeId\": 123,\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"WatcherIds\": [\n    123\n  ],\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedOn\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Title\": \"Office 365 migration\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"GroupId\": 101,\n  \"Description\": \"<string>\",\n  \"LeadAssigneeId\": 123,\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"WatcherIds\": [\n    123\n  ],\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedOn\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Autorizações

X-API-Key

string

header

obrigatório

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Corpo

Project details.

Request body for creating a project. The owning service provider is resolved from the request context, not from the body.

Title

string

obrigatório

Project title. Required.

Minimum string length: 1

Exemplo:

"Office 365 migration"

ClientId

integer<int64>

obrigatório

Identifier of the client the project belongs to. Required.

LocationId

integer<int64>

obrigatório

Identifier of the client location the project belongs to. Required.

TypeId

string<uuid>

obrigatório

Identifier of the project type. Required.

GroupId

integer<int64>

obrigatório

Identifier of the technician group the project is assigned to. Required.

Exemplo:

101

Description

string | null

Project description.

LeadAssigneeId

integer<int64> | null

Identifier of the technician to lead the project. Optional - a project created without one has no lead, and none is assigned by default.

TagIds

string<uuid>[] | null

Identifiers of tags to apply to the project.

WatcherIds

integer<int64>[] | null

Identifiers of technicians to watch the project. The lead is never also a watcher.

SharedWithContactIds

integer<int64>[] | null

Identifiers of contacts to share the project with. They must belong to ClientId.

TargetDate

string<date-time> | null

Date the project is targeted to finish (UTC).

CreatedByName

string | null

Display name to record as the project creator. An API key is not a person, so when it is omitted or blank the creator is recorded as API.

CreatedOn

string<date-time> | null

Backdate the project's creation timestamp - for importing projects from another system. Must not be in the future. Omit to use the current time. Send only when importing history. A record with this field set sends no emails or notifications.

UpdatedOn

string<date-time> | null

Backdate the project's last-activity timestamp so an imported project does not sort above live work. Must not be in the future or earlier than CreatedOn. Defaults to the effective creation time.

Resposta

StatusCode

enum<integer>

Opções disponíveis:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

The identifier of the created project.

Show child attributes

DataContext

object | null

Exemplo:

null

Notifications

object[]

Show child attributes

⌘I

Creates a project for the authenticated service provider.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/projects \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Title": "Office 365 migration",
  "ClientId": 123,
  "LocationId": 123,
  "TypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "GroupId": 101,
  "Description": "<string>",
  "LeadAssigneeId": 123,
  "TagIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "WatcherIds": [
    123
  ],
  "SharedWithContactIds": [
    123
  ],
  "TargetDate": "2023-11-07T05:31:56Z",
  "CreatedByName": "<string>",
  "CreatedOn": "2023-11-07T05:31:56Z",
  "UpdatedOn": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/projects"

payload = {
    "Title": "Office 365 migration",
    "ClientId": 123,
    "LocationId": 123,
    "TypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "GroupId": 101,
    "Description": "<string>",
    "LeadAssigneeId": 123,
    "TagIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "WatcherIds": [123],
    "SharedWithContactIds": [123],
    "TargetDate": "2023-11-07T05:31:56Z",
    "CreatedByName": "<string>",
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdatedOn": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Title: 'Office 365 migration',
    ClientId: 123,
    LocationId: 123,
    TypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    GroupId: 101,
    Description: '<string>',
    LeadAssigneeId: 123,
    TagIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    WatcherIds: [123],
    SharedWithContactIds: [123],
    TargetDate: '2023-11-07T05:31:56Z',
    CreatedByName: '<string>',
    CreatedOn: '2023-11-07T05:31:56Z',
    UpdatedOn: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.usw.gorelo.io/v1/projects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/projects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Title' => 'Office 365 migration',
    'ClientId' => 123,
    'LocationId' => 123,
    'TypeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'GroupId' => 101,
    'Description' => '<string>',
    'LeadAssigneeId' => 123,
    'TagIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'WatcherIds' => [
        123
    ],
    'SharedWithContactIds' => [
        123
    ],
    'TargetDate' => '2023-11-07T05:31:56Z',
    'CreatedByName' => '<string>',
    'CreatedOn' => '2023-11-07T05:31:56Z',
    'UpdatedOn' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/projects"

	payload := strings.NewReader("{\n  \"Title\": \"Office 365 migration\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"GroupId\": 101,\n  \"Description\": \"<string>\",\n  \"LeadAssigneeId\": 123,\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"WatcherIds\": [\n    123\n  ],\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedOn\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usw.gorelo.io/v1/projects")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Title\": \"Office 365 migration\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"GroupId\": 101,\n  \"Description\": \"<string>\",\n  \"LeadAssigneeId\": 123,\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"WatcherIds\": [\n    123\n  ],\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedOn\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Title\": \"Office 365 migration\",\n  \"ClientId\": 123,\n  \"LocationId\": 123,\n  \"TypeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"GroupId\": 101,\n  \"Description\": \"<string>\",\n  \"LeadAssigneeId\": 123,\n  \"TagIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"WatcherIds\": [\n    123\n  ],\n  \"SharedWithContactIds\": [\n    123\n  ],\n  \"TargetDate\": \"2023-11-07T05:31:56Z\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedOn\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}