Templates

All Templates

get

This endpoint is used to fetch all templates in the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

template_idstring · max: 25Required

template_namestringOptional

descriptionstringOptional

is_predefinedbooleanOptional

get/api/templates/template/

GET /api/templates/template/?items_per_page=1&page=1 HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "template_id": "text",
    "template_name": "text",
    "description": "text",
    "template_config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "is_predefined": true,
    "options": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Creates a new template

post

This endpoint is used to save a new template for the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body

Other propertiesanyOptional

Responses

201

No response body

No content

post/api/templates/template/

POST /api/templates/template/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 675

{
  "template_name": "New UX Design",
  "description": "A template for new UX design",
  "template_config": {
    "stages": [
      {
        "stage_id": "1",
        "name": "Brainstorming session",
        "color": "#FFCCCC",
        "status": {
          "status_id": 3,
          "status_key": "completed",
          "status_name": "Completed"
        }
      },
      {
        "stage_id": "2",
        "name": "Kick-off call",
        "color": "#FFCCCC",
        "status": {
          "status_id": 3,
          "status_key": "completed",
          "status_name": "Completed"
        }
      },
      {
        "stage_id": "3",
        "name": "Getting feedback",
        "color": "#FFD700",
        "status": {
          "status_id": 2,
          "status_key": "in_progress",
          "status_name": "In Progress"
        }
      },
      {
        "stage_id": "4",
        "name": "High fidelity wireframes",
        "color": "#FFD700",
        "status": {
          "status_id": 2,
          "status_key": "in_progress",
          "status_name": "In Progress"
        }
      }
    ]
  }
}

201

No response body

No content

Gets a template with the given id

get

This endpoint is used to fetch a template details for the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

idstringRequired

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

template_idstring · max: 25Required

template_namestringOptional

descriptionstringOptional

is_predefinedbooleanOptional

get/api/templates/template/{id}/

GET /api/templates/template/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "template_id": "text",
  "template_name": "text",
  "description": "text",
  "template_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_predefined": true,
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Edits the template with the given id

put

This endpoint is used to edit an template for the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

idstringRequired

Body

Other propertiesanyOptional

Responses

200

No response body

No content

put/api/templates/template/{id}/

PUT /api/templates/template/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "name": "UX Design",
  "description": "A template for design"
}

200

No response body

No content

Deletes the template with the given id

delete

This endpoint is used to delete an template for the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

idstringRequired

Responses

204

No response body

No content

delete/api/templates/template/{id}/

DELETE /api/templates/template/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

get

API endpoint that allows templates to be created, viewed, deleted or edited.

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

template_idstring · max: 25Required

template_namestringOptional

descriptionstringOptional

is_predefinedbooleanOptional

get/api/templates/template/ai-milestone/

GET /api/templates/template/ai-milestone/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "template_id": "text",
  "template_name": "text",
  "description": "text",
  "template_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_predefined": true,
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

API endpoint that allows templates to be created, viewed, deleted or edited.

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

template_idstring · max: 25Required

template_namestringOptional

descriptionstringOptional

is_predefinedbooleanOptional

get/api/templates/template/ai-template/

GET /api/templates/template/ai-template/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "template_id": "text",
  "template_name": "text",
  "description": "text",
  "template_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_predefined": true,
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

API endpoint that allows templates to be created, viewed, deleted or edited.

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

template_idstring · max: 25Required

template_namestringOptional

descriptionstringOptional

is_predefinedbooleanOptional

get/api/templates/template/default/

GET /api/templates/template/default/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "template_id": "text",
  "template_name": "text",
  "description": "text",
  "template_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_predefined": true,
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

API endpoint that allows templates to be created, viewed, deleted or edited.

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

template_idstring · max: 25Required

template_namestringOptional

descriptionstringOptional

is_predefinedbooleanOptional

get/api/templates/template/paginated-templates/

GET /api/templates/template/paginated-templates/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "template_id": "text",
  "template_name": "text",
  "description": "text",
  "template_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_predefined": true,
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}