Document Resource

Get All Documents

HTTP Request

GET /api/documents

Interactive Demo

📋 Description: Fetches a list of documents available within the system, enabling users to access and review relevant documentation efficiently.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "contentType": "string",
    "documentTypeName": "string",
    "documentTypeId": 0,
    "description": "string",
    "data": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "documentStatusId": 0,
    "documentStatus": "string",
    "documentStatusType": "string",
    "parentEntityId": 0,
    "link": "string",
    "parentEntityName": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DocumentDTO]	false	none	[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» name	string	false	none	Name of the resource
» contentType	string	false	none	Type of the content
» documentTypeName	string	false	none	Name of the document type
» documentTypeId	integer(int64)	false	none	Unique identifier for the document type
» description	string	false	none	Description of the resource
» data	string(byte)	false	none	Contains the primary content of the document, providing essential information relevant to the associated business process.
» startDate	string(date)	false	none	Start date of the resource
» endDate	string(date)	false	none	End date of the resource
» documentStatusId	integer(int64)	false	none	Unique identifier for the document status
» documentStatus	string	false	none	Status of the document
» documentStatusType	string	false	none	Type of the document status
» parentEntityId	integer(int64)	true	none	Unique identifier for the parent entity
» link	string	false	none	URL reference to the associated document, facilitating easy access and retrieval within the system.
» parentEntityName	string	true	none	Name of the parent entity

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Document

HTTP Request

POST /api/documents

Interactive Demo

📋 Description: Creates a new document in the system, allowing users to efficiently manage and store essential business information.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the document details, including title, content, and associated metadata for effective document management.
» documentAttach	body	DocumentDTO	true	Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.
»» id	body	integer(int64)	false	Unique identifier for the resource
»» createdBy	body	string	false	Username of who created this resource
»» createdAt	body	string(date-time)	false	Timestamp when this resource was created
»» name	body	string	false	Name of the resource
»» contentType	body	string	false	Type of the content
»» documentTypeName	body	string	false	Name of the document type
»» documentTypeId	body	integer(int64)	false	Unique identifier for the document type
»» description	body	string	false	Description of the resource
»» data	body	string(byte)	false	Contains the primary content of the document, providing essential information relevant to the associated business process.
»» startDate	body	string(date)	false	Start date of the resource
»» endDate	body	string(date)	false	End date of the resource
»» documentStatusId	body	integer(int64)	false	Unique identifier for the document status
»» documentStatus	body	string	false	Status of the document
»» documentStatusType	body	string	false	Type of the document status
»» parentEntityId	body	integer(int64)	true	Unique identifier for the parent entity
»» link	body	string	false	URL reference to the associated document, facilitating easy access and retrieval within the system.
»» parentEntityName	body	string	true	Name of the parent entity
» file	body	string(binary)	true	none

Body Parameters

{
  "documentAttach": {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "contentType": "string",
    "documentTypeName": "string",
    "documentTypeId": 0,
    "description": "string",
    "data": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "documentStatusId": 0,
    "documentStatus": "string",
    "documentStatusType": "string",
    "parentEntityId": 0,
    "link": "string",
    "parentEntityName": "string"
  },
  "file": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	integer

Example Responses

0

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Download Attachment

HTTP Request

POST /api/documents/{id}/download

Interactive Demo

📋 Description: Initiates the download of a specified document by its unique identifier, facilitating easy access to essential business resources.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	StreamingResponseBody

Example Responses

{}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Upload Picture

HTTP Request

POST /api/documents/picture

Interactive Demo

📋 Description: Uploads a new picture document to the system, enabling users to enhance their records with visual content for improved documentation and presentation.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the image data and associated metadata for document processing and storage.
» documentAttach	body	DocumentDTO	true	Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.
»» id	body	integer(int64)	false	Unique identifier for the resource
»» createdBy	body	string	false	Username of who created this resource
»» createdAt	body	string(date-time)	false	Timestamp when this resource was created
»» name	body	string	false	Name of the resource
»» contentType	body	string	false	Type of the content
»» documentTypeName	body	string	false	Name of the document type
»» documentTypeId	body	integer(int64)	false	Unique identifier for the document type
»» description	body	string	false	Description of the resource
»» data	body	string(byte)	false	Contains the primary content of the document, providing essential information relevant to the associated business process.
»» startDate	body	string(date)	false	Start date of the resource
»» endDate	body	string(date)	false	End date of the resource
»» documentStatusId	body	integer(int64)	false	Unique identifier for the document status
»» documentStatus	body	string	false	Status of the document
»» documentStatusType	body	string	false	Type of the document status
»» parentEntityId	body	integer(int64)	true	Unique identifier for the parent entity
»» link	body	string	false	URL reference to the associated document, facilitating easy access and retrieval within the system.
»» parentEntityName	body	string	true	Name of the parent entity
» file	body	string(binary)	true	none

Body Parameters

{
    "documentAttach": {
        "contentType": "string",
        "createdAt": "2019-08-24 14:15:22+00:00",
        "createdBy": "string",
        "data": "string",
        "description": "string",
        "documentStatus": "string",
        "documentStatusId": 0,
        "documentStatusType": "string",
        "documentTypeId": 0,
        "documentTypeName": "string",
        "endDate": "2019-08-24",
        "id": 0,
        "link": "string",
        "name": "string",
        "parentEntityId": 0,
        "parentEntityName": "string",
        "startDate": "2019-08-24"
    },
    "file": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	string

Example Responses

"string"

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Upload Worker Incident

HTTP Request

POST /api/documents/picture/workerIncident

Interactive Demo

📋 Description: Submits a picture related to a worker incident for documentation and review, facilitating timely incident reporting and compliance management.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the details of the worker incident picture, including associated incident identifiers and relevant metadata for documentation purposes.
» documentAttach	body	DocumentDTO	true	Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.
»» id	body	integer(int64)	false	Unique identifier for the resource
»» createdBy	body	string	false	Username of who created this resource
»» createdAt	body	string(date-time)	false	Timestamp when this resource was created
»» name	body	string	false	Name of the resource
»» contentType	body	string	false	Type of the content
»» documentTypeName	body	string	false	Name of the document type
»» documentTypeId	body	integer(int64)	false	Unique identifier for the document type
»» description	body	string	false	Description of the resource
»» data	body	string(byte)	false	Contains the primary content of the document, providing essential information relevant to the associated business process.
»» startDate	body	string(date)	false	Start date of the resource
»» endDate	body	string(date)	false	End date of the resource
»» documentStatusId	body	integer(int64)	false	Unique identifier for the document status
»» documentStatus	body	string	false	Status of the document
»» documentStatusType	body	string	false	Type of the document status
»» parentEntityId	body	integer(int64)	true	Unique identifier for the parent entity
»» link	body	string	false	URL reference to the associated document, facilitating easy access and retrieval within the system.
»» parentEntityName	body	string	true	Name of the parent entity
» file	body	string(binary)	true	none

Body Parameters

{
    "documentAttach": {
        "contentType": "string",
        "createdAt": "2019-08-24 14:15:22+00:00",
        "createdBy": "string",
        "data": "string",
        "description": "string",
        "documentStatus": "string",
        "documentStatusId": 0,
        "documentStatusType": "string",
        "documentTypeId": 0,
        "documentTypeName": "string",
        "endDate": "2019-08-24",
        "id": 0,
        "link": "string",
        "name": "string",
        "parentEntityId": 0,
        "parentEntityName": "string",
        "startDate": "2019-08-24"
    },
    "file": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	DocumentDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "contentType": "string",
  "documentTypeName": "string",
  "documentTypeId": 0,
  "description": "string",
  "data": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "documentStatusId": 0,
  "documentStatus": "string",
  "documentStatusType": "string",
  "parentEntityId": 0,
  "link": "string",
  "parentEntityName": "string"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Upload Invoice Picture

HTTP Request

POST /api/documents/picture/invoice

Interactive Demo

📋 Description: Uploads a picture of an invoice to the document management system, enabling efficient processing and storage for financial records.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the invoice image data along with associated metadata for processing and record-keeping.
» documentAttach	body	DocumentDTO	true	Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.
»» id	body	integer(int64)	false	Unique identifier for the resource
»» createdBy	body	string	false	Username of who created this resource
»» createdAt	body	string(date-time)	false	Timestamp when this resource was created
»» name	body	string	false	Name of the resource
»» contentType	body	string	false	Type of the content
»» documentTypeName	body	string	false	Name of the document type
»» documentTypeId	body	integer(int64)	false	Unique identifier for the document type
»» description	body	string	false	Description of the resource
»» data	body	string(byte)	false	Contains the primary content of the document, providing essential information relevant to the associated business process.
»» startDate	body	string(date)	false	Start date of the resource
»» endDate	body	string(date)	false	End date of the resource
»» documentStatusId	body	integer(int64)	false	Unique identifier for the document status
»» documentStatus	body	string	false	Status of the document
»» documentStatusType	body	string	false	Type of the document status
»» parentEntityId	body	integer(int64)	true	Unique identifier for the parent entity
»» link	body	string	false	URL reference to the associated document, facilitating easy access and retrieval within the system.
»» parentEntityName	body	string	true	Name of the parent entity
» file	body	string(binary)	true	none

Body Parameters

{
    "documentAttach": {
        "contentType": "string",
        "createdAt": "2019-08-24 14:15:22+00:00",
        "createdBy": "string",
        "data": "string",
        "description": "string",
        "documentStatus": "string",
        "documentStatusId": 0,
        "documentStatusType": "string",
        "documentTypeId": 0,
        "documentTypeName": "string",
        "endDate": "2019-08-24",
        "id": 0,
        "link": "string",
        "name": "string",
        "parentEntityId": 0,
        "parentEntityName": "string",
        "startDate": "2019-08-24"
    },
    "file": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	DocumentDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "contentType": "string",
  "documentTypeName": "string",
  "documentTypeId": 0,
  "description": "string",
  "data": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "documentStatusId": 0,
  "documentStatus": "string",
  "documentStatusType": "string",
  "parentEntityId": 0,
  "link": "string",
  "parentEntityName": "string"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Upload Inspection Picture

HTTP Request

POST /api/documents/picture/inspection

Interactive Demo

📋 Description: Uploads an inspection picture to the document management system, enabling enhanced tracking and documentation of inspection activities.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the image data and associated inspection details necessary for document verification and compliance assessment.
» documentAttach	body	DocumentDTO	true	Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.
»» id	body	integer(int64)	false	Unique identifier for the resource
»» createdBy	body	string	false	Username of who created this resource
»» createdAt	body	string(date-time)	false	Timestamp when this resource was created
»» name	body	string	false	Name of the resource
»» contentType	body	string	false	Type of the content
»» documentTypeName	body	string	false	Name of the document type
»» documentTypeId	body	integer(int64)	false	Unique identifier for the document type
»» description	body	string	false	Description of the resource
»» data	body	string(byte)	false	Contains the primary content of the document, providing essential information relevant to the associated business process.
»» startDate	body	string(date)	false	Start date of the resource
»» endDate	body	string(date)	false	End date of the resource
»» documentStatusId	body	integer(int64)	false	Unique identifier for the document status
»» documentStatus	body	string	false	Status of the document
»» documentStatusType	body	string	false	Type of the document status
»» parentEntityId	body	integer(int64)	true	Unique identifier for the parent entity
»» link	body	string	false	URL reference to the associated document, facilitating easy access and retrieval within the system.
»» parentEntityName	body	string	true	Name of the parent entity
» file	body	string(binary)	true	none

Body Parameters

{
    "documentAttach": {
        "contentType": "string",
        "createdAt": "2019-08-24 14:15:22+00:00",
        "createdBy": "string",
        "data": "string",
        "description": "string",
        "documentStatus": "string",
        "documentStatusId": 0,
        "documentStatusType": "string",
        "documentTypeId": 0,
        "documentTypeName": "string",
        "endDate": "2019-08-24",
        "id": 0,
        "link": "string",
        "name": "string",
        "parentEntityId": 0,
        "parentEntityName": "string",
        "startDate": "2019-08-24"
    },
    "file": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	DocumentDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "contentType": "string",
  "documentTypeName": "string",
  "documentTypeId": 0,
  "description": "string",
  "data": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "documentStatusId": 0,
  "documentStatus": "string",
  "documentStatusType": "string",
  "parentEntityId": 0,
  "link": "string",
  "parentEntityName": "string"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Document

HTTP Request

GET /api/documents/{id}

Interactive Demo

📋 Description: Fetches the document details associated with the specified identifier, enabling users to access essential information for review and decision-making.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	DocumentDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "contentType": "string",
  "documentTypeName": "string",
  "documentTypeId": 0,
  "description": "string",
  "data": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "documentStatusId": 0,
  "documentStatus": "string",
  "documentStatusType": "string",
  "parentEntityId": 0,
  "link": "string",
  "parentEntityName": "string"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Document

HTTP Request

DELETE /api/documents/{id}

Interactive Demo

📋 Description: Deletes a specified document from the system, ensuring that sensitive information is securely removed and maintaining data integrity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
404	Not Found	Document not found	None
500	Internal Server Error	Internal server error	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Preview Image

HTTP Request

GET /api/documents/{id}/preview

Interactive Demo

📋 Description: Fetches a preview of the specified document by its unique identifier, enabling users to quickly assess content before proceeding with further actions.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

Example Responses

"string"

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Documents By Entity

HTTP Request

GET /api/documents/{entity}/{entityId}

Interactive Demo

📋 Description: Retrieves detailed information about a specific document associated with the specified entity, enabling users to access critical data for informed decision-making.

Parameters

Name	In	Type	Required	Description
entity	path	string	true	Specifies the type of entity (e.g., document, user) being accessed in the API request, enabling targeted retrieval of associated data.
entityId	path	integer(int64)	true	Unique identifier for the entity

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "contentType": "string",
    "documentTypeName": "string",
    "documentTypeId": 0,
    "description": "string",
    "data": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "documentStatusId": 0,
    "documentStatus": "string",
    "documentStatusType": "string",
    "parentEntityId": 0,
    "link": "string",
    "parentEntityName": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DocumentDTO]	false	none	[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» name	string	false	none	Name of the resource
» contentType	string	false	none	Type of the content
» documentTypeName	string	false	none	Name of the document type
» documentTypeId	integer(int64)	false	none	Unique identifier for the document type
» description	string	false	none	Description of the resource
» data	string(byte)	false	none	Contains the primary content of the document, providing essential information relevant to the associated business process.
» startDate	string(date)	false	none	Start date of the resource
» endDate	string(date)	false	none	End date of the resource
» documentStatusId	integer(int64)	false	none	Unique identifier for the document status
» documentStatus	string	false	none	Status of the document
» documentStatusType	string	false	none	Type of the document status
» parentEntityId	integer(int64)	true	none	Unique identifier for the parent entity
» link	string	false	none	URL reference to the associated document, facilitating easy access and retrieval within the system.
» parentEntityName	string	true	none	Name of the parent entity

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Worker Incident Pictures

HTTP Request

GET /api/documents/workerIncident/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific worker incident by its unique identifier, enabling effective incident management and reporting.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "contentType": "string",
    "documentTypeName": "string",
    "documentTypeId": 0,
    "description": "string",
    "data": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "documentStatusId": 0,
    "documentStatus": "string",
    "documentStatusType": "string",
    "parentEntityId": 0,
    "link": "string",
    "parentEntityName": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DocumentDTO]	false	none	[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» name	string	false	none	Name of the resource
» contentType	string	false	none	Type of the content
» documentTypeName	string	false	none	Name of the document type
» documentTypeId	integer(int64)	false	none	Unique identifier for the document type
» description	string	false	none	Description of the resource
» data	string(byte)	false	none	Contains the primary content of the document, providing essential information relevant to the associated business process.
» startDate	string(date)	false	none	Start date of the resource
» endDate	string(date)	false	none	End date of the resource
» documentStatusId	integer(int64)	false	none	Unique identifier for the document status
» documentStatus	string	false	none	Status of the document
» documentStatusType	string	false	none	Type of the document status
» parentEntityId	integer(int64)	true	none	Unique identifier for the parent entity
» link	string	false	none	URL reference to the associated document, facilitating easy access and retrieval within the system.
» parentEntityName	string	true	none	Name of the parent entity

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Other Pictures By Entity

HTTP Request

GET /api/documents/pictures/{parentId}

Interactive Demo

📋 Description: Retrieves a list of pictures associated with the specified parent document ID, enabling efficient management and organization of visual assets within the document repository.

Parameters

Name	In	Type	Required	Description
parentId	path	integer(int64)	true	Unique identifier for the parent

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "contentType": "string",
    "documentTypeName": "string",
    "documentTypeId": 0,
    "description": "string",
    "data": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "documentStatusId": 0,
    "documentStatus": "string",
    "documentStatusType": "string",
    "parentEntityId": 0,
    "link": "string",
    "parentEntityName": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DocumentDTO]	false	none	[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» name	string	false	none	Name of the resource
» contentType	string	false	none	Type of the content
» documentTypeName	string	false	none	Name of the document type
» documentTypeId	integer(int64)	false	none	Unique identifier for the document type
» description	string	false	none	Description of the resource
» data	string(byte)	false	none	Contains the primary content of the document, providing essential information relevant to the associated business process.
» startDate	string(date)	false	none	Start date of the resource
» endDate	string(date)	false	none	End date of the resource
» documentStatusId	integer(int64)	false	none	Unique identifier for the document status
» documentStatus	string	false	none	Status of the document
» documentStatusType	string	false	none	Type of the document status
» parentEntityId	integer(int64)	true	none	Unique identifier for the parent entity
» link	string	false	none	URL reference to the associated document, facilitating easy access and retrieval within the system.
» parentEntityName	string	true	none	Name of the parent entity

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Picture By Entity

HTTP Request

GET /api/documents/picture/{parentType}/{parentId}

Interactive Demo

📋 Description: Retrieves the associated picture document for a specified parent entity, identified by its type and ID, to facilitate visual representation within the business context.

Parameters

Name	In	Type	Required	Description
parentType	path	string	true	Type of the parent
parentId	path	integer(int64)	true	Unique identifier for the parent

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

Delete Picture

HTTP Request

DELETE /api/documents/picture/{parentType}/{parentId}

Interactive Demo

📋 Description: Deletes a specified picture document associated with a given parent type and parent ID, ensuring the removal of outdated or irrelevant visual assets from the system.

Parameters

Name	In	Type	Required	Description
parentType	path	string	true	Type of the parent
parentId	path	integer(int64)	true	Unique identifier for the parent

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Picture By ID

HTTP Request

GET /api/documents/picture/{id}

Interactive Demo

📋 Description: Retrieves the specified picture document by its unique identifier, enabling users to access and review visual assets associated with their projects.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

Get Inspection Item Pictures

HTTP Request

GET /api/documents/inspectionItem/{id}

Interactive Demo

📋 Description: Fetches detailed information about a specific inspection item identified by its unique ID, enabling users to access critical data for compliance and quality assurance purposes.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "contentType": "string",
    "documentTypeName": "string",
    "documentTypeId": 0,
    "description": "string",
    "data": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "documentStatusId": 0,
    "documentStatus": "string",
    "documentStatusType": "string",
    "parentEntityId": 0,
    "link": "string",
    "parentEntityName": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DocumentDTO]	false	none	[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» name	string	false	none	Name of the resource
» contentType	string	false	none	Type of the content
» documentTypeName	string	false	none	Name of the document type
» documentTypeId	integer(int64)	false	none	Unique identifier for the document type
» description	string	false	none	Description of the resource
» data	string(byte)	false	none	Contains the primary content of the document, providing essential information relevant to the associated business process.
» startDate	string(date)	false	none	Start date of the resource
» endDate	string(date)	false	none	End date of the resource
» documentStatusId	integer(int64)	false	none	Unique identifier for the document status
» documentStatus	string	false	none	Status of the document
» documentStatusType	string	false	none	Type of the document status
» parentEntityId	integer(int64)	true	none	Unique identifier for the parent entity
» link	string	false	none	URL reference to the associated document, facilitating easy access and retrieval within the system.
» parentEntityName	string	true	none	Name of the parent entity

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get All Active Document Type IDs

HTTP Request

GET /api/documents/allActiveDocumentTypes

Interactive Demo

📋 Description: Retrieves a list of all active document types within the system, enabling users to efficiently manage and categorize documents for streamlined business operations.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  0
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Worker Incident Picture

HTTP Request

DELETE /api/documents/workerIncident/{workerIncidentId}/picture/{pictureId}

Interactive Demo

📋 Description: Deletes a specific picture associated with a worker incident, allowing for the management and maintenance of incident documentation.

Parameters

Name	In	Type	Required	Description
workerIncidentId	path	integer(int64)	true	Unique identifier for the worker incident
pictureId	path	integer(int64)	true	Unique identifier for the picture

Responses

Status	Meaning	Description	Schema
204	No Content	Worker Incident picture deleted successfully	None
404	Not Found	Worker Incident or picture not found	None
500	Internal Server Error	Internal server error	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Invoice Picture

HTTP Request

DELETE /api/documents/invoice/{invoiceId}/picture/{pictureId}

Interactive Demo

📋 Description: Deletes a specified picture associated with an invoice, allowing for the management and organization of invoice-related visual documentation.

Parameters

Name	In	Type	Required	Description
invoiceId	path	integer(int64)	true	Unique identifier for the invoice
pictureId	path	integer(int64)	true	Unique identifier for the picture

Responses

Status	Meaning	Description	Schema
204	No Content	Invoice picture deleted successfully	None
404	Not Found	Invoice or picture not found	None
500	Internal Server Error	Internal server error	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Energy Cost Document

HTTP Request

DELETE /api/documents/energyCost/{id}

Interactive Demo

📋 Description: Deletes a specified energy cost document by its unique identifier, ensuring the removal of outdated or unnecessary records from the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None
404	Not Found	Document not found	None
500	Internal Server Error	Internal server error	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---