Tracciati CSV

Risorse REST per il caricamento e la consultazione dei tracciati CSV

La risorsa POST /file non viene visualizzata correttamente in questa documentazione.

La risorsa, come definito nell'OpenAPI, si aspetta una richiesta multipart/form-data ed il part file con content-type text/csv

Upload a new csv trace.

Allows to upload a csv trace for a GovIO service.

POSThttp://localhost:10001/files

Query parameters

Body

multipart/form-data

filestring (binary)

Response

200400401403404429503default

Successful operation.

Body

application/hal+json

id*GovioFileId (integer (int64))

Govio File Id.

Example: 1

filenameFileName (string)

Example: "file1.csv"

Pattern: .*

user*FileUserItem (object)

service_instance_idGovioServiceInstanceId (integer (int64))

Govio Service Instance Id.

Example: 1

status*FileStatus (enum)

createdprocessingprocessed

creation_date*string (date-time)

processing_datestring (date-time)

error_messagesinteger (int64)

Example: 9999

acquired_messagesinteger (int64)

Example: 9999

_linksobject

_embeddedobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/files?service_instance=1', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404429503default

{
  "id": 1,
  "filename": "file1.csv",
  "user": {
    "id": 1,
    "full_name": "Antonio Giscardi"
  },
  "service_instance_id": 1,
  "status": "created",
  "creation_date": "2024-09-30T01:21:52.110Z",
  "processing_date": "2024-09-30T01:21:52.110Z",
  "error_messages": 9999,
  "acquired_messages": 9999,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/files/1"
    },
    "content": {
      "href": "https://govhub.it/govio/files/1/content"
    },
    "service-instace": {
      "href": "https://govhub.it/govio/service-instances/1"
    }
  },
  "_embedded": {
    "service-instance": {
      "service_id": 1,
      "organization_id": 1,
      "template_id": 1,
      "enabled": true,
      "io_service_id": "text",
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/service-instances/1"
        },
        "service": {
          "href": "https://govhub.it/govio/services/1"
        },
        "organization": {
          "href": "https://govhub.it/govio/organizations/1"
        },
        "template": {
          "href": "https://govhub.it/govio/templates/1"
        }
      },
      "_embedded": {
        "service": {
          "id": 1,
          "service_name": "SUAP-Integrazione",
          "description": "Service for customer management.",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/services/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/services/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/services/logo_miniature"
            }
          }
        },
        "organization": {
          "id": 1,
          "legal_name": "Giletti S.R.L.",
          "tax_code": "01234567890",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/organizations/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/organizations/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/organizations/logo_miniature"
            }
          }
        },
        "template": {
          "name": "Spedizione Messaggio CIE",
          "description": "Segnala la scadenza della proprià C.I.E.",
          "subject": "Scadenza CIE n. ${cie.uppercase}",
          "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
          "has_payment": false,
          "has_due_date": false,
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/templates/1"
            },
            "placeholders": {
              "href": "https://govhub.it/govio/templates/1/placeholders"
            }
          }
        }
      }
    }
  }
}

Retrieve the uploaded csv traces

Retrieve the csv traces

GEThttp://localhost:10001/files

Query parameters

Response

200400401403429503default

Successful operation.

Body

application/hal+json

page*PageInfo (object)

items*array of GovioFile (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/files?sort_direction=asc&sort=unsorted', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403429503default

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "id": 1,
      "filename": "file1.csv",
      "user": {
        "id": 1,
        "full_name": "Antonio Giscardi"
      },
      "service_instance_id": 1,
      "status": "created",
      "creation_date": "2024-09-30T01:21:52.110Z",
      "processing_date": "2024-09-30T01:21:52.110Z",
      "error_messages": 9999,
      "acquired_messages": 9999,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/files/1"
        },
        "content": {
          "href": "https://govhub.it/govio/files/1/content"
        },
        "service-instace": {
          "href": "https://govhub.it/govio/service-instances/1"
        }
      },
      "_embedded": {
        "service-instance": {
          "service_id": 1,
          "organization_id": 1,
          "template_id": 1,
          "enabled": true,
          "io_service_id": "text",
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/service-instances/1"
            },
            "service": {
              "href": "https://govhub.it/govio/services/1"
            },
            "organization": {
              "href": "https://govhub.it/govio/organizations/1"
            },
            "template": {
              "href": "https://govhub.it/govio/templates/1"
            }
          },
          "_embedded": {
            "service": {
              "id": 1,
              "service_name": "SUAP-Integrazione",
              "description": "Service for customer management.",
              "_links": {
                "self": {
                  "href": "https://govhub.it/govregistry/services/1"
                },
                "logo": {
                  "href": "https://govhub.it/govregistry/services/1/logo"
                },
                "logo_miniature": {
                  "href": "https://govhub.it/govregistry/services/logo_miniature"
                }
              }
            },
            "organization": {
              "id": 1,
              "legal_name": "Giletti S.R.L.",
              "tax_code": "01234567890",
              "_links": {
                "self": {
                  "href": "https://govhub.it/govregistry/organizations/1"
                },
                "logo": {
                  "href": "https://govhub.it/govregistry/organizations/1/logo"
                },
                "logo_miniature": {
                  "href": "https://govhub.it/govregistry/organizations/logo_miniature"
                }
              }
            },
            "template": {
              "name": "Spedizione Messaggio CIE",
              "description": "Segnala la scadenza della proprià C.I.E.",
              "subject": "Scadenza CIE n. ${cie.uppercase}",
              "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
              "has_payment": false,
              "has_due_date": false,
              "id": 1,
              "_links": {
                "self": {
                  "href": "https://govhub.it/govio/templates/1"
                },
                "placeholders": {
                  "href": "https://govhub.it/govio/templates/1/placeholders"
                }
              }
            }
          }
        }
      }
    }
  ]
}

Retrieve the uploaded csv trace.

Retrieve the csv trace.

GEThttp://localhost:10001/files/{id}

Path parameters

id*GovioFileId (integer (int64))

Govio File Id.

Example: 1

Response

200400401403404429503default

Successful operation.

Body

application/hal+json

id*GovioFileId (integer (int64))

Govio File Id.

Example: 1

filenameFileName (string)

Example: "file1.csv"

Pattern: .*

user*FileUserItem (object)

service_instance_idGovioServiceInstanceId (integer (int64))

Govio Service Instance Id.

Example: 1

status*FileStatus (enum)

createdprocessingprocessed

creation_date*string (date-time)

processing_datestring (date-time)

error_messagesinteger (int64)

Example: 9999

acquired_messagesinteger (int64)

Example: 9999

_linksobject

_embeddedobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/files/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404429503default

{
  "id": 1,
  "filename": "file1.csv",
  "user": {
    "id": 1,
    "full_name": "Antonio Giscardi"
  },
  "service_instance_id": 1,
  "status": "created",
  "creation_date": "2024-09-30T01:21:52.110Z",
  "processing_date": "2024-09-30T01:21:52.110Z",
  "error_messages": 9999,
  "acquired_messages": 9999,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/files/1"
    },
    "content": {
      "href": "https://govhub.it/govio/files/1/content"
    },
    "service-instace": {
      "href": "https://govhub.it/govio/service-instances/1"
    }
  },
  "_embedded": {
    "service-instance": {
      "service_id": 1,
      "organization_id": 1,
      "template_id": 1,
      "enabled": true,
      "io_service_id": "text",
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/service-instances/1"
        },
        "service": {
          "href": "https://govhub.it/govio/services/1"
        },
        "organization": {
          "href": "https://govhub.it/govio/organizations/1"
        },
        "template": {
          "href": "https://govhub.it/govio/templates/1"
        }
      },
      "_embedded": {
        "service": {
          "id": 1,
          "service_name": "SUAP-Integrazione",
          "description": "Service for customer management.",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/services/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/services/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/services/logo_miniature"
            }
          }
        },
        "organization": {
          "id": 1,
          "legal_name": "Giletti S.R.L.",
          "tax_code": "01234567890",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/organizations/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/organizations/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/organizations/logo_miniature"
            }
          }
        },
        "template": {
          "name": "Spedizione Messaggio CIE",
          "description": "Segnala la scadenza della proprià C.I.E.",
          "subject": "Scadenza CIE n. ${cie.uppercase}",
          "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
          "has_payment": false,
          "has_due_date": false,
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/templates/1"
            },
            "placeholders": {
              "href": "https://govhub.it/govio/templates/1/placeholders"
            }
          }
        }
      }
    }
  }
}

Retrieve the file content of the uploaded csv trace.

Retrieve the file content

GEThttp://localhost:10001/files/{id}/content

Path parameters

id*GovioFileId (integer (int64))

Govio File Id.

Example: 1

Response

200400401403404429503default

Successful operation.

Body

application/octet-stream

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/files/{id}/content', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404429503default

binary

Retrieve the file processing messages.

Retrieve the file messages.

GEThttp://localhost:10001/files/{id}/file-messages

Path parameters

id*GovioFileId (integer (int64))

Govio File Id.

Example: 1

Query parameters

Response

200400401403404429503default

Successful operation.

Body

application/hal+json

page*PageInfo (object)

items*array of FileMessage (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/files/{id}/file-messages?file_message_status=aqcuired', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404429503default

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "id": 1,
      "line_number": 1,
      "line_record": "text",
      "message": {
        "id": 1
      },
      "error": "text",
      "status": "aqcuired"
    }
  ]
}