Configurazione

Risorse per la configurazione dei template e placeholders

PreviousSpedizione messaggi via CSV NextTracciati CSV

Last updated 1 year ago

Reads a service template.

get

Reads a service template.

Authorizations

Path parameters

idinteger · int64required

GovIO Template Id.

Example: 1

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:10001/templates/{id}' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY'

200

400

401

403

404

429

503

default

{
  "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": true,
  "has_due_date": true,
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/templates/1"
    },
    "placeholders": {
      "href": "https://govhub.it/govio/templates/1/placeholders"
    }
  }
}

Successful operation.

List the template placeholders.

get

List the template associated placeholders.

Authorizations

Path parameters

idinteger · int64required

GovIO Template Id.

Example: 1

Query parameters

embedstring · enum[] · max: 1024optional

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:10001/templates/{id}/placeholders' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY'

200

400

401

403

404

429

503

default

{
  "items": [
    {
      "mandatory": true,
      "position": 1,
      "placeholder_id": 1,
      "_links": {
        "placeholder": {
          "href": "https://govhub.it/govio/placeholders/1"
        },
        "template": {
          "href": "https://govhub.it/govio/templates/1"
        }
      },
      "_embedded": {
        "placeholder": {
          "name": "cie",
          "description": "Numero carta d'identità elettronica.",
          "example": "CA000000AA",
          "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
          "type": "string",
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/placeholders/1"
            }
          }
        },
        "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": true,
          "has_due_date": true,
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/templates/1"
            },
            "placeholders": {
              "href": "https://govhub.it/govio/templates/1/placeholders"
            }
          }
        }
      }
    }
  ]
}

Successful operation.

Removes the placeholder from the template.

delete

Removes the placeholder from the template.

Authorizations

Path parameters

template_idinteger · int64required

GovIO Template Id.

Example: 1

placeholder_idinteger · int64required

GovIO Placeholder Id.

Example: 1

Responses

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:10001/templates/{template_id}/placeholders/{placeholder_id}' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY'

200

400

401

403

404

429

503

default

No body

Successful operation.

List the placeholders.

get

Placeholders can be reused across templates, this endpoints allows to list them.

Authorizations

Query parameters

limitinteger · int32 · min: 1 · max: 100optional

Max number of provided items.

offsetinteger · int64 · max: 9223372036854776000optional

offset (zero-based) of indexed results.

Default: 0

qstring · max: 255optional

generic query.

Example: user_1Pattern: ^[^\u0000]*$

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:10001/placeholders' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY'

200

400

401

403

429

503

default

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "name": "cie",
      "description": "Numero carta d'identità elettronica.",
      "example": "CA000000AA",
      "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
      "type": "string",
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/placeholders/1"
        }
      }
    }
  ]
}

Successful operation.

Read the specified placeholder.

get

Placeholders can be reused across templates, this endpoints allows to read one of them.

Authorizations

Path parameters

idinteger · int64required

GovIO Placeholder Id.

Example: 1

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:10001/placeholders/{id}' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY'

200

400

401

403

404

429

503

default

{
  "name": "cie",
  "description": "Numero carta d'identità elettronica.",
  "example": "CA000000AA",
  "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
  "type": "string",
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/placeholders/1"
    }
  }
}

Successful operation.

List Govio Service Instances

get

Read and Filter the Govio Service Instanes

Authorizations

Query parameters

service_idinteger · int64 · max: 9223372036854776000optional

Service identifier.

Example: 1

organization_idinteger · int64 · max: 9223372036854776000optional

Organization identifier.

Example: 1

io_service_idstring · min: 1 · max: 255optional

qstring · max: 255optional

generic query.

Example: user_1Pattern: ^[^\u0000]*$

enabledbooleanoptional

filter by status.

limitinteger · int32 · min: 1 · max: 100optional

Max number of provided items.

offsetinteger · int64 · max: 9223372036854776000optional

offset (zero-based) of indexed results.

Default: 0

sort_directionstring · enumrequired

Direction Sorting field.

Default: descAvailable options:

embedstring · enum[] · max: 1024optional

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:10001/service-instances?sort_direction=asc' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY'

200

400

401

403

429

503

default

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "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": true,
          "has_due_date": true,
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/templates/1"
            },
            "placeholders": {
              "href": "https://govhub.it/govio/templates/1/placeholders"
            }
          }
        }
      }
    }
  ]
}

Successful operation.

Retrieve a service instance.

get

Returns the specified service instance.

Authorizations

Path parameters

idinteger · int64required

Govio Service Instance Id.

Example: 1

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:10001/service-instances/{id}' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY'

200

400

401

403

404

429

503

default

{
  "service_id": 1,
  "organization_id": 1,
  "template_id": 1,
  "enabled": true,
  "io_service_id": "text",
  "apiKey": "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": true,
      "has_due_date": true,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  }
}

Successful operation.

List the templates.

get

List the templates used for sending messages to the govio services,sorted by name.

Authorizations

Query parameters

limitinteger · int32 · min: 1 · max: 100optional

Max number of provided items.

offsetinteger · int64 · max: 9223372036854776000optional

offset (zero-based) of indexed results.

Default: 0

qstring · max: 255optional

generic query.

Example: user_1Pattern: ^[^\u0000]*$

sort_directionstring · enumrequired

Direction Sorting field.

Default: descAvailable options:

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:10001/templates?sort_direction=asc' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY'

200

400

401

403

429

503

default

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "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": true,
      "has_due_date": true,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  ]
}

Successful operation.

Create a new template.

post

Create a new template for sending messages to the govio services.

Authorizations

Body

namestring · max: 255requiredExample: Spedizione Messaggio CIEPattern: .*

descriptionstring · max: 9223372036854776000optionalExample: Segnala la scadenza della proprià C.I.E.Pattern: [\s\S]*

subjectstring · max: 255requiredExample: Scadenza CIE n. ${cie.uppercase}Pattern: .+

message_bodystring · max: 9223372036854776000requiredExample:

Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.

Pattern: [\s\S]+

has_paymentbooleanrequired

has_due_datebooleanrequired

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:10001/templates' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": true,
    "has_due_date": true
  }'

201

400

401

403

429

503

default

{
  "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": true,
  "has_due_date": true,
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/templates/1"
    },
    "placeholders": {
      "href": "https://govhub.it/govio/templates/1/placeholders"
    }
  }
}

Successful operation.

Update template data.

patch

Update template data.

Authorizations

Path parameters

idinteger · int64required

GovIO Template Id.

Example: 1

Body

opstring · enumrequired

Specified operation.

Example: addAvailable options:

pathstring · max: 4096required

jsonPath of the mutating object.

Example: /organizationsPattern: ^.*$

valueobjectoptional

updating value.

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'http://localhost:10001/templates/{id}' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '[
    {
      "op": "add",
      "path": "/name",
      "value": "Comune1"
    }
  ]'

200

400

401

403

404

429

503

default

{
  "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": true,
  "has_due_date": true,
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/templates/1"
    },
    "placeholders": {
      "href": "https://govhub.it/govio/templates/1/placeholders"
    }
  }
}

Succsessful operation.

Assign a placeholder to a template.

post

Associate a placeholder to a template.

Authorizations

Path parameters

idinteger · int64required

GovIO Template Id.

Example: 1

Query parameters

placeholder_idinteger · int64required

GovIO Placeholder Id.

Example: 1

Body

mandatorybooleanrequired

positioninteger · int32 · max: 2147483647required

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:10001/templates/{id}/placeholders?placeholder_id=1' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "mandatory": true,
    "position": 1
  }'

201

400

401

403

404

409

429

503

default

{
  "mandatory": true,
  "position": 1,
  "placeholder_id": 1,
  "_links": {
    "placeholder": {
      "href": "https://govhub.it/govio/placeholders/1"
    },
    "template": {
      "href": "https://govhub.it/govio/templates/1"
    }
  },
  "_embedded": {
    "placeholder": {
      "name": "cie",
      "description": "Numero carta d'identità elettronica.",
      "example": "CA000000AA",
      "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
      "type": "string",
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/placeholders/1"
        }
      }
    },
    "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": true,
      "has_due_date": true,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  }
}

Successful operation.

Update the template placeholders.

put

Updates the whole template placeholder list.

Authorizations

Path parameters

idinteger · int64required

GovIO Template Id.

Example: 1

Body

itemsall of[] · max: 2147483647optional

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:10001/templates/{id}/placeholders' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "mandatory": false,
        "position": 0,
        "placeholder_id": 1
      },
      {
        "mandatory": false,
        "position": 1,
        "placeholder_id": 10
      },
      {
        "mandatory": true,
        "position": 4,
        "placeholder_id": 2
      }
    ]
  }'

201

400

401

403

404

429

503

default

{
  "items": [
    {
      "mandatory": false,
      "position": 0,
      "placeholder_id": 1
    },
    {
      "mandatory": false,
      "position": 1,
      "placeholder_id": 10
    },
    {
      "mandatory": true,
      "position": 4,
      "placeholder_id": 2
    }
  ]
}

Successful operation.

Create a new template placeholder.

post

Placeholders can be reused across templates, this endpoints allows to create one.

Authorizations

Body

namestring · max: 255requiredExample: ciePattern: .+

descriptionstring · max: 9223372036854776000optionalExample: Numero carta d'identità elettronica.Pattern: [\s\S]*

examplestring · max: 255requiredExample: CA000000AAPattern: [\s\S]+

patternstring · max: 255optionalExample: [A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]Pattern: [\s\S]*

typestring · enumrequiredAvailable options:

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:10001/placeholders' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "cie",
    "description": "Numero carta d'identità elettronica.",
    "example": "CA000000AA",
    "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
    "type": "string"
  }'

201

400

401

403

409

429

503

default

{
  "name": "cie",
  "description": "Numero carta d'identità elettronica.",
  "example": "CA000000AA",
  "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
  "type": "string",
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/placeholders/1"
    }
  }
}

Successful operation.

Update placeholder data.

patch

Update placeholder data.

Authorizations

Path parameters

idinteger · int64required

GovIO Placeholder Id.

Example: 1

Body

opstring · enumrequired

Specified operation.

Example: addAvailable options:

pathstring · max: 4096required

jsonPath of the mutating object.

Example: /organizationsPattern: ^.*$

valueobjectoptional

updating value.

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'http://localhost:10001/placeholders/{id}' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '[
    {
      "op": "add",
      "path": "/name",
      "value": "cie"
    }
  ]'

200

400

401

403

404

429

503

default

{
  "name": "cie",
  "description": "Numero carta d'identità elettronica.",
  "example": "CA000000AA",
  "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
  "type": "string",
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/placeholders/1"
    }
  }
}

Succsessful operation.

Creates a new Service Instance.

post

An organization can subscribe to a service multiple times, each time with a different message template, then the clients can send messages to the IO service using the service instance.

Authorizations

Body

all ofoptional

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:10001/service-instances' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "service_id": 1,
    "organization_id": 1,
    "template_id": 1,
    "enabled": true,
    "io_service_id": "text",
    "apiKey": "text"
  }'

200

400

401

403

404

429

503

default

{
  "service_id": 1,
  "organization_id": 1,
  "template_id": 1,
  "enabled": true,
  "io_service_id": "text",
  "apiKey": "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": true,
      "has_due_date": true,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  }
}

Successful operation.

Update the service instance.

patch

Only the apiKey can be modified by this operation.

Authorizations

Path parameters

idinteger · int64required

Govio Service Instance Id.

Example: 1

Body

opstring · enumrequired

Specified operation.

Example: addAvailable options:

pathstring · max: 4096required

jsonPath of the mutating object.

Example: /organizationsPattern: ^.*$

valueobjectoptional

updating value.

Responses

application/hal+json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'http://localhost:10001/service-instances/{id}' \
  --header 'GovHub-Consumer-Principal: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '[
    {
      "op": "add",
      "path": "/organizations",
      "value": {}
    }
  ]'

200

400

401

403

404

409

429

503

default

{
  "service_id": 1,
  "organization_id": 1,
  "template_id": 1,
  "enabled": true,
  "io_service_id": "text",
  "apiKey": "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": true,
      "has_due_date": true,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  }
}

Succsessful operation.

Reads a service template.

List the template placeholders.

Show child attributes

Removes the placeholder from the template.

List the placeholders.

Read the specified placeholder.

List Govio Service Instances

Show child attributes

Retrieve a service instance.

List the templates.

Create a new template.

Update template data.

Assign a placeholder to a template.

Update the template placeholders.

Show all of

Create a new template placeholder.

Update placeholder data.

Creates a new Service Instance.

Show child attributes

Show child attributes

Update the service instance.