Card Management API
 4.3.2.RELEASE 
OAS 2.0

[ Base URL: localhost:2002/cards ]

IMPORTANT - The Try it Out button will generate curl requests for examples, but executing them through the UI will not work as authentication has not been set up. This page is for documentation only.

Send email to the developer
Mozilla Public License V2.0

cards

Everything concerning cards

fetch cards restricted to calling user. Fetched cards all come with empty data and details. requesting this end point opens an SSE connection

Parameters

NameDescription
rangeStart
string($date-time)
(query)

start of time range to get published card

rangeEnd
string($date-time)
(query)

end of time range to get published card

notification
boolean
(query)

If true, connection is kept for notification of new cards (not related to the specified range)

Default value : false

clientId
string
(query)

A unique id to identify client to allow for reconnection (an autogenerated UUID is the best solution)

Responses

CodeDescription
200

ok

[
  {
    "type": "DELETE",
    "cardId": 12345
  }
]
401

Authentication required

403

Forbidden - User doesn't have any group

Update existing subscription

Parameters

NameDescription
uiId *
string
(path)

unique ui client id associated to subscription

subscription
object
(body)

updated subscription

{
  "rangeStart": 1551868290379,
  "rangeEnd": 1551868290379
}

Responses

CodeDescription
200

OK

{
  "rangeStart": 1551868290379,
  "rangeEnd": 1551868290379
}
400

Bad request (body doesn't match login path parameter)

401

Authentication required

404

Subscription not found

get published cards matching the criteria given as parameters. Results are limited to the cards that the calling user is allowed to see (based on the card recipients). For performance reasons, the response does not contain all lightCard fields, the returned fields are : id, uid,publisher, processVersion,process, processInstanceId,state,title,summary,publishDate,startDate,endDate,severity, publisherType, representative,representativeType. The other fields are set to null.

Parameters

NameDescription
filter
object
(body)
{
  "page": 0,
  "size": 0,
  "adminMode": true,
  "includeChildCards": true,
  "latestUpdateOnly": true,
  "filters": [
    {
      "columnName": "string",
      "matchType": "EQUALS",
      "filter": [
        "string"
      ],
      "operation": "AND"
    }
  ],
  "selectedFields": [
    "string"
  ]
}

Responses

CodeDescription
200

OK

{
  "content": [
    {
      "uid": 12345,
      "id": "cardIdFromMyProcess",
      "publisher": "MyService",
      "processVersion": "0.0.1",
      "processInstanceId": "MyProcess_001",
      "lttd": 1546387230000,
      "startDate": 1546387200000,
      "endDate": 1546387250000,
      "expirationDate": 1546397250000,
      "severity": "ACTION",
      "tags": [
        "MyService",
        "MyProcess"
      ],
      "title": {
        "key": "myservice.myprocess.title",
        "parameters": {
          "EN": "My process name",
          "FR": "Mon nom de processus"
        }
      },
      "summary": {
        "key": "myservice.myprocess.title.summary",
        "parameters": {
          "EN": "Summary of card content",
          "FR": "Resume du contenu de la carte"
        }
      },
      "titleTranslated": "My process name",
      "summaryTranslated": "Summary of card content"
    }
  ],
  "first": true,
  "last": true,
  "totalPages": 0,
  "totalElements": 0,
  "numberOfElements": 0,
  "size": 0,
  "number": 0
}
400

Bad request

401

Authentication required

403

Forbidden - User doesn't have any group

Delete cards from OperatorFabric where card endDate is before the specified date or where card has no endDate and startDate is before the specified date.

Parameters

NameDescription
(query)
endDateBefore
()
number
()
number
()

Responses

CodeDescription
200

OK

delete a card

Parameters

NameDescription
id *
string
(path)

The id parameter is constructed as follows : {process}.{processInstanceId}

Responses

CodeDescription
200

OK

fetch current card for process id

Parameters

NameDescription
id *
string
(path)

The id parameter is constructed as follows : {process}.{processInstanceId}

Responses

CodeDescription
200

OK

{
  "uid": 12345,
  "id": "cardIdFromMyProcess",
  "publisher": "MyService",
  "processVersion": "0.0.1",
  "process": "MyProcess",
  "processInstanceId": "MyProcess_001",
  "state": "started",
  "publishDate": 1546300800000,
  "lttd": 1546387230000,
  "startDate": 1546387200000,
  "endDate": 1546387250000,
  "expirationDate": 1546397250000,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess"
  ],
  "title": {
    "key": "myservice.myprocess.title"
  },
  "summary": {
    "key": "myservice.myprocess.title.summary"
  }
}
401

Authentication required

403

Forbidden - User doesn't have any group

update current card users acknowledgements, adding a new item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

entitiesAcks
array[string]
(body)

List of user entities for which the card will be acknowledged

[
  "string"
]

Responses

CodeDescription
200

No action done, the item already exists

201

Created

404

Try to remove item from unexisting card

update current card users acknowledgements, removing an item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

entitiesAcks
array[string]
(body)

List of user entities for which the card will be acknowledged

[
  "string"
]

Responses

CodeDescription
200

Item removed

204

Try to remove unexisting item

404

Try to remove item from unexisting card

update current card users reads, adding a new item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

No action done, the item already exists

201

Created

404

Try to remove item from unexisting card

update current card users reads, removing an item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

No action done, the item already exists

201

Created

404

Try to remove item from unexisting card

update current card removing acknowledgements and reads, send the card with updated publishDate

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

card updated and sent with updated publishDate

403

Forbidden - User not allowed

404

Try to update unexisting card

read

Everything concerning resource state

fetch cards restricted to calling user. Fetched cards all come with empty data and details. requesting this end point opens an SSE connection

Parameters

NameDescription
rangeStart
string($date-time)
(query)

start of time range to get published card

rangeEnd
string($date-time)
(query)

end of time range to get published card

notification
boolean
(query)

If true, connection is kept for notification of new cards (not related to the specified range)

Default value : false

clientId
string
(query)

A unique id to identify client to allow for reconnection (an autogenerated UUID is the best solution)

Responses

CodeDescription
200

ok

[
  {
    "type": "DELETE",
    "cardId": 12345
  }
]
401

Authentication required

403

Forbidden - User doesn't have any group

get published cards matching the criteria given as parameters. Results are limited to the cards that the calling user is allowed to see (based on the card recipients). For performance reasons, the response does not contain all lightCard fields, the returned fields are : id, uid,publisher, processVersion,process, processInstanceId,state,title,summary,publishDate,startDate,endDate,severity, publisherType, representative,representativeType. The other fields are set to null.

Parameters

NameDescription
filter
object
(body)
{
  "page": 0,
  "size": 0,
  "adminMode": true,
  "includeChildCards": true,
  "latestUpdateOnly": true,
  "filters": [
    {
      "columnName": "string",
      "matchType": "EQUALS",
      "filter": [
        "string"
      ],
      "operation": "AND"
    }
  ],
  "selectedFields": [
    "string"
  ]
}

Responses

CodeDescription
200

OK

{
  "content": [
    {
      "uid": 12345,
      "id": "cardIdFromMyProcess",
      "publisher": "MyService",
      "processVersion": "0.0.1",
      "processInstanceId": "MyProcess_001",
      "lttd": 1546387230000,
      "startDate": 1546387200000,
      "endDate": 1546387250000,
      "expirationDate": 1546397250000,
      "severity": "ACTION",
      "tags": [
        "MyService",
        "MyProcess"
      ],
      "title": {
        "key": "myservice.myprocess.title",
        "parameters": {
          "EN": "My process name",
          "FR": "Mon nom de processus"
        }
      },
      "summary": {
        "key": "myservice.myprocess.title.summary",
        "parameters": {
          "EN": "Summary of card content",
          "FR": "Resume du contenu de la carte"
        }
      },
      "titleTranslated": "My process name",
      "summaryTranslated": "Summary of card content"
    }
  ],
  "first": true,
  "last": true,
  "totalPages": 0,
  "totalElements": 0,
  "numberOfElements": 0,
  "size": 0,
  "number": 0
}
400

Bad request

401

Authentication required

403

Forbidden - User doesn't have any group

fetch archived card with the given id

Parameters

NameDescription
id *
string
(path)

Responses

CodeDescription
200

OK

{
  "uid": 12345,
  "id": "cardIdFromMyProcess",
  "publisher": "MyService",
  "processVersion": "0.0.1",
  "process": "MyProcess",
  "processInstanceId": "MyProcess_001",
  "state": "started",
  "publishDate": 1546300800000,
  "lttd": 1546387230000,
  "startDate": 1546387200000,
  "endDate": 1546387250000,
  "expirationDate": 1546397250000,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess"
  ],
  "title": {
    "key": "myservice.myprocess.title"
  },
  "summary": {
    "key": "myservice.myprocess.title.summary"
  }
}
401

Authentication required

403

Forbidden - User doesn't have any group

get archived cards matching the criteria given as parameters. Results are limited to the cards that the calling user is allowed to see (based on the card recipients). For performance reasons, the response does not contain all lightCard fields, the returned fields are : id, uid,publisher, processVersion,process, processInstanceId,state,title,summary,publishDate,startDate,endDate,severity, publisherType, representative,representativeType. The other fields are set to null.

Parameters

NameDescription
filter
object
(body)
{
  "page": 0,
  "size": 0,
  "adminMode": true,
  "includeChildCards": true,
  "latestUpdateOnly": true,
  "filters": [
    {
      "columnName": "string",
      "matchType": "EQUALS",
      "filter": [
        "string"
      ],
      "operation": "AND"
    }
  ],
  "selectedFields": [
    "string"
  ]
}

Responses

CodeDescription
200

OK

{
  "content": [
    {
      "uid": 12345,
      "id": "cardIdFromMyProcess",
      "publisher": "MyService",
      "processVersion": "0.0.1",
      "processInstanceId": "MyProcess_001",
      "lttd": 1546387230000,
      "startDate": 1546387200000,
      "endDate": 1546387250000,
      "expirationDate": 1546397250000,
      "severity": "ACTION",
      "tags": [
        "MyService",
        "MyProcess"
      ],
      "title": {
        "key": "myservice.myprocess.title",
        "parameters": {
          "EN": "My process name",
          "FR": "Mon nom de processus"
        }
      },
      "summary": {
        "key": "myservice.myprocess.title.summary",
        "parameters": {
          "EN": "Summary of card content",
          "FR": "Resume du contenu de la carte"
        }
      },
      "titleTranslated": "My process name",
      "summaryTranslated": "Summary of card content"
    }
  ],
  "first": true,
  "last": true,
  "totalPages": 0,
  "totalElements": 0,
  "numberOfElements": 0,
  "size": 0,
  "number": 0
}
400

Bad request

401

Authentication required

403

Forbidden - User doesn't have any group

fetch current card for process id

Parameters

NameDescription
id *
string
(path)

The id parameter is constructed as follows : {process}.{processInstanceId}

Responses

CodeDescription
200

OK

{
  "uid": 12345,
  "id": "cardIdFromMyProcess",
  "publisher": "MyService",
  "processVersion": "0.0.1",
  "process": "MyProcess",
  "processInstanceId": "MyProcess_001",
  "state": "started",
  "publishDate": 1546300800000,
  "lttd": 1546387230000,
  "startDate": 1546387200000,
  "endDate": 1546387250000,
  "expirationDate": 1546397250000,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess"
  ],
  "title": {
    "key": "myservice.myprocess.title"
  },
  "summary": {
    "key": "myservice.myprocess.title.summary"
  }
}
401

Authentication required

403

Forbidden - User doesn't have any group

update current card users reads, adding a new item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

No action done, the item already exists

201

Created

404

Try to remove item from unexisting card

update current card users reads, removing an item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

No action done, the item already exists

201

Created

404

Try to remove item from unexisting card

creation

Everything concerning resource creation

deletion

Everything concerning resource deletion

Delete cards from OperatorFabric where card endDate is before the specified date or where card has no endDate and startDate is before the specified date.

Parameters

NameDescription
(query)
endDateBefore
()
number
()
number
()

Responses

CodeDescription
200

OK

delete a card

Parameters

NameDescription
id *
string
(path)

The id parameter is constructed as follows : {process}.{processInstanceId}

Responses

CodeDescription
200

OK

archives

Everything concerning archived cards

fetch archived card with the given id

Parameters

NameDescription
id *
string
(path)

Responses

CodeDescription
200

OK

{
  "uid": 12345,
  "id": "cardIdFromMyProcess",
  "publisher": "MyService",
  "processVersion": "0.0.1",
  "process": "MyProcess",
  "processInstanceId": "MyProcess_001",
  "state": "started",
  "publishDate": 1546300800000,
  "lttd": 1546387230000,
  "startDate": 1546387200000,
  "endDate": 1546387250000,
  "expirationDate": 1546397250000,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess"
  ],
  "title": {
    "key": "myservice.myprocess.title"
  },
  "summary": {
    "key": "myservice.myprocess.title.summary"
  }
}
401

Authentication required

403

Forbidden - User doesn't have any group

get archived cards matching the criteria given as parameters. Results are limited to the cards that the calling user is allowed to see (based on the card recipients). For performance reasons, the response does not contain all lightCard fields, the returned fields are : id, uid,publisher, processVersion,process, processInstanceId,state,title,summary,publishDate,startDate,endDate,severity, publisherType, representative,representativeType. The other fields are set to null.

Parameters

NameDescription
filter
object
(body)
{
  "page": 0,
  "size": 0,
  "adminMode": true,
  "includeChildCards": true,
  "latestUpdateOnly": true,
  "filters": [
    {
      "columnName": "string",
      "matchType": "EQUALS",
      "filter": [
        "string"
      ],
      "operation": "AND"
    }
  ],
  "selectedFields": [
    "string"
  ]
}

Responses

CodeDescription
200

OK

{
  "content": [
    {
      "uid": 12345,
      "id": "cardIdFromMyProcess",
      "publisher": "MyService",
      "processVersion": "0.0.1",
      "processInstanceId": "MyProcess_001",
      "lttd": 1546387230000,
      "startDate": 1546387200000,
      "endDate": 1546387250000,
      "expirationDate": 1546397250000,
      "severity": "ACTION",
      "tags": [
        "MyService",
        "MyProcess"
      ],
      "title": {
        "key": "myservice.myprocess.title",
        "parameters": {
          "EN": "My process name",
          "FR": "Mon nom de processus"
        }
      },
      "summary": {
        "key": "myservice.myprocess.title.summary",
        "parameters": {
          "EN": "Summary of card content",
          "FR": "Resume du contenu de la carte"
        }
      },
      "titleTranslated": "My process name",
      "summaryTranslated": "Summary of card content"
    }
  ],
  "first": true,
  "last": true,
  "totalPages": 0,
  "totalElements": 0,
  "numberOfElements": 0,
  "size": 0,
  "number": 0
}
400

Bad request

401

Authentication required

403

Forbidden - User doesn't have any group

subscription

fetch cards restricted to calling user. Fetched cards all come with empty data and details. requesting this end point opens an SSE connection

Parameters

NameDescription
rangeStart
string($date-time)
(query)

start of time range to get published card

rangeEnd
string($date-time)
(query)

end of time range to get published card

notification
boolean
(query)

If true, connection is kept for notification of new cards (not related to the specified range)

Default value : false

clientId
string
(query)

A unique id to identify client to allow for reconnection (an autogenerated UUID is the best solution)

Responses

CodeDescription
200

ok

[
  {
    "type": "DELETE",
    "cardId": 12345
  }
]
401

Authentication required

403

Forbidden - User doesn't have any group

Update existing subscription

Parameters

NameDescription
uiId *
string
(path)

unique ui client id associated to subscription

subscription
object
(body)

updated subscription

{
  "rangeStart": 1551868290379,
  "rangeEnd": 1551868290379
}

Responses

CodeDescription
200

OK

{
  "rangeStart": 1551868290379,
  "rangeEnd": 1551868290379
}
400

Bad request (body doesn't match login path parameter)

401

Authentication required

404

Subscription not found

default

Parameters

No parameters

Responses

CodeDescription
200

rate limiter reset

400

bad request

Parameters

No parameters

Responses

CodeDescription
200

remote logs sent

400

bad request

Parameters

NameDescription
card
object
(body)
{
  "uid": 12345,
  "id": "cardIdFromMyProcess",
  "publisher": "MyService",
  "processVersion": "0.0.1",
  "process": "MyProcess",
  "processInstanceId": "MyProcess_001",
  "state": "started",
  "publishDate": 1546300800000,
  "lttd": 1546387230000,
  "startDate": 1546387200000,
  "endDate": 1546387250000,
  "expirationDate": 1546397250000,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess"
  ],
  "title": {
    "key": "myservice.myprocess.title"
  },
  "summary": {
    "key": "myservice.myprocess.title.summary"
  }
}

Responses

CodeDescription
200

OK

[
  "string"
]
400

Bad request

Get translated field for a given i18n value

Parameters

NameDescription
fieldToTranslate
(body)
{
  "i18nValue": {
    "key": "title",
    "parameters": {
      "EN": "My Title",
      "FR": "Mon Titre"
    }
  },
  "process": "string",
  "processVersion": "string"
}

Responses

CodeDescription
200

OK

"string"
400

Bad request

401

Authentication required

update

update current card users acknowledgements, adding a new item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

entitiesAcks
array[string]
(body)

List of user entities for which the card will be acknowledged

[
  "string"
]

Responses

CodeDescription
200

No action done, the item already exists

201

Created

404

Try to remove item from unexisting card

update current card users reads, adding a new item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

No action done, the item already exists

201

Created

404

Try to remove item from unexisting card

update current card users reads, removing an item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

No action done, the item already exists

201

Created

404

Try to remove item from unexisting card

update current card removing acknowledgements and reads, send the card with updated publishDate

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

card updated and sent with updated publishDate

403

Forbidden - User not allowed

404

Try to update unexisting card

acknowledgement

update current card users acknowledgements, adding a new item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

entitiesAcks
array[string]
(body)

List of user entities for which the card will be acknowledged

[
  "string"
]

Responses

CodeDescription
200

No action done, the item already exists

201

Created

404

Try to remove item from unexisting card

update current card users acknowledgements, removing an item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

entitiesAcks
array[string]
(body)

List of user entities for which the card will be acknowledged

[
  "string"
]

Responses

CodeDescription
200

Item removed

204

Try to remove unexisting item

404

Try to remove item from unexisting card

update current card removing acknowledgements and reads, send the card with updated publishDate

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

card updated and sent with updated publishDate

403

Forbidden - User not allowed

404

Try to update unexisting card

delete

update current card users acknowledgements, removing an item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

entitiesAcks
array[string]
(body)

List of user entities for which the card will be acknowledged

[
  "string"
]

Responses

CodeDescription
200

Item removed

204

Try to remove unexisting item

404

Try to remove item from unexisting card