Swagger UI

Card Management API
 2.11.0.RELEASE 

[ 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.

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

[
  {
    "number": 3,
    "publishDate": 1546300800000,
    "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,
  "loadedCards": [
    "string"
  ]
}

Responses

CodeDescription
200

OK

{
  "rangeStart": 1551868290379,
  "rangeEnd": 1551868290379,
  "loadedCards": [
    "string"
  ]
}
400

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

401

Authentication required

404

Subscription not found

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
()

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,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess",
    "ACTION"
  ],
  "actions": [
    {
      "type": "URL",
      "lockAction": true,
      "called": false,
      "updateStateBeforeAction": false,
      "hidden": true,
      "buttonStyle": "button.css",
      "label": {
        "key": "myCard.myAction.label",
        "parameters": {
          "EN": "My actions label",
          "FR": "Mon intitule d'actions"
        }
      }
    }
  ],
  "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"
    }
  }
}
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

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

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

actions

Everything concerning actions

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

[
  {
    "number": 3,
    "publishDate": 1546300800000,
    "type": "DELETE",
    "cardId": [
      12345
    ]
  }
]
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
page
number
(query)

Page number of the page to retrieve. If "size" is set but "page" isn't, the default page returned will be the first (number 0). If "page" is set but "size" isn't, the default size will be 10 items. If neither "page" nor "size" is set, the response will contain a single page containing all matching cards. This parameter should be unique or a BAD REQUEST will be returned.

size
number
(query)

Size of the results pages. If "size" is set but "page" isn't, the default page returned will be the first (number 0). If "page" is set but "size" isn't, the default size will be 10 items. If neither "page" nor "size" is set, the response will contain a single page containing all matching cards. This parameter should be unique or a BAD REQUEST will be returned.

publishDateFrom
number
(query)

Date as number of milliseconds since epoch. If this query parameter is set, only cards with a publishDate that is after this date will be returned. This parameter should be unique or a BAD REQUEST will be returned.

publishDateTo
number
(query)

Date as number of milliseconds since epoch. If this query parameter is set, only cards with a publishDate that is before this date will be returned. This parameter should be unique or a BAD REQUEST will be returned.

activeFrom
number
(query)

Date as number of milliseconds since epoch. If this query parameter is set, only cards with an active period (as defined by their startDate and endDate properties) that overlaps the range [activeFrom, activeTo] will be returned. If no parameter activeTo is set, only cards with at least part of their active period after activeFrom will be returned. This parameter should be unique or a BAD REQUEST will be returned.

activeTo
number
(query)

Date as number of milliseconds since epoch. If this query parameter is set, only cards with an active period (as defined by their startDate and endDate properties) that overlaps the range [activeFrom, activeTo] will be returned. If no parameter activeFrom is set, only cards with at least part of their active period before activeTo will be returned. This parameter should be unique or a BAD REQUEST will be returned.

publisher
string
(query)

If this parameter is set, results will be limited to cards from this publisher. This parameter can be set multiple times to filter cards from several publishers, using the following syntax: ?publisher=publisher1&publisher=publisher2

process
string
(query)

If this parameter is set, results will be limited to cards from this process. This parameter can be set multiple times to filter cards from several processes, using the following syntax: ?process=process1&process=process2

tags
string
(query)

If this parameter is set, results will be limited to cards containing this tag. This parameter can be set multiple times to filter cards with several tags, using the following syntax: ?tags=tag1&tags=tag2. In this example, cards bearing either tag1 or tag2 (or both) will be returned.

XXXX
string
(query)

In addition to the query parameters described above, any query parameter of the form ?key=value, where "key" is the name of a card field, will filter cards to return only cards where the field "key" is either equal to the string "value" or to an array containing "value". If key isn't a card property, the filter will have no effect.

childCards
boolean
(query)

If this parameter is set to true, child cards will be included in the results. If the parameter is absent or set to false, child cards will not be included.

Responses

CodeDescription
200

OK

{
  "content": [
    {
      "uid": 12345,
      "id": "cardIdFromMyProcess",
      "publisher": "MyService",
      "processVersion": "0.0.1",
      "processInstanceId": "MyProcess_001",
      "lttd": 1546387230000,
      "startDate": 1546387200000,
      "endDate": 1546387250000,
      "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"
        }
      }
    }
  ],
  "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,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess",
    "ACTION"
  ],
  "actions": [
    {
      "type": "URL",
      "lockAction": true,
      "called": false,
      "updateStateBeforeAction": false,
      "hidden": true,
      "buttonStyle": "button.css",
      "label": {
        "key": "myCard.myAction.label",
        "parameters": {
          "EN": "My actions label",
          "FR": "Mon intitule d'actions"
        }
      }
    }
  ],
  "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"
    }
  }
}
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,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess",
    "ACTION"
  ],
  "actions": [
    {
      "type": "URL",
      "lockAction": true,
      "called": false,
      "updateStateBeforeAction": false,
      "hidden": true,
      "buttonStyle": "button.css",
      "label": {
        "key": "myCard.myAction.label",
        "parameters": {
          "EN": "My actions label",
          "FR": "Mon intitule d'actions"
        }
      }
    }
  ],
  "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"
    }
  }
}
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

Publish one card to OperatorFabric

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,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess",
    "ACTION"
  ],
  "actions": [
    {
      "type": "URL",
      "lockAction": true,
      "called": false,
      "updateStateBeforeAction": false,
      "hidden": true,
      "buttonStyle": "button.css",
      "label": {
        "key": "myCard.myAction.label",
        "parameters": {
          "EN": "My actions label",
          "FR": "Mon intitule d'actions"
        }
      }
    }
  ],
  "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"
    }
  }
}

Responses

CodeDescription
201

created

{
  "id": "string",
  "uid": "string"
}
400

bad request

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
()

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

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
page
number
(query)

Page number of the page to retrieve. If "size" is set but "page" isn't, the default page returned will be the first (number 0). If "page" is set but "size" isn't, the default size will be 10 items. If neither "page" nor "size" is set, the response will contain a single page containing all matching cards. This parameter should be unique or a BAD REQUEST will be returned.

size
number
(query)

Size of the results pages. If "size" is set but "page" isn't, the default page returned will be the first (number 0). If "page" is set but "size" isn't, the default size will be 10 items. If neither "page" nor "size" is set, the response will contain a single page containing all matching cards. This parameter should be unique or a BAD REQUEST will be returned.

publishDateFrom
number
(query)

Date as number of milliseconds since epoch. If this query parameter is set, only cards with a publishDate that is after this date will be returned. This parameter should be unique or a BAD REQUEST will be returned.

publishDateTo
number
(query)

Date as number of milliseconds since epoch. If this query parameter is set, only cards with a publishDate that is before this date will be returned. This parameter should be unique or a BAD REQUEST will be returned.

activeFrom
number
(query)

Date as number of milliseconds since epoch. If this query parameter is set, only cards with an active period (as defined by their startDate and endDate properties) that overlaps the range [activeFrom, activeTo] will be returned. If no parameter activeTo is set, only cards with at least part of their active period after activeFrom will be returned. This parameter should be unique or a BAD REQUEST will be returned.

activeTo
number
(query)

Date as number of milliseconds since epoch. If this query parameter is set, only cards with an active period (as defined by their startDate and endDate properties) that overlaps the range [activeFrom, activeTo] will be returned. If no parameter activeFrom is set, only cards with at least part of their active period before activeTo will be returned. This parameter should be unique or a BAD REQUEST will be returned.

publisher
string
(query)

If this parameter is set, results will be limited to cards from this publisher. This parameter can be set multiple times to filter cards from several publishers, using the following syntax: ?publisher=publisher1&publisher=publisher2

process
string
(query)

If this parameter is set, results will be limited to cards from this process. This parameter can be set multiple times to filter cards from several processes, using the following syntax: ?process=process1&process=process2

tags
string
(query)

If this parameter is set, results will be limited to cards containing this tag. This parameter can be set multiple times to filter cards with several tags, using the following syntax: ?tags=tag1&tags=tag2. In this example, cards bearing either tag1 or tag2 (or both) will be returned.

XXXX
string
(query)

In addition to the query parameters described above, any query parameter of the form ?key=value, where "key" is the name of a card field, will filter cards to return only cards where the field "key" is either equal to the string "value" or to an array containing "value". If key isn't a card property, the filter will have no effect.

childCards
boolean
(query)

If this parameter is set to true, child cards will be included in the results. If the parameter is absent or set to false, child cards will not be included.

Responses

CodeDescription
200

OK

{
  "content": [
    {
      "uid": 12345,
      "id": "cardIdFromMyProcess",
      "publisher": "MyService",
      "processVersion": "0.0.1",
      "processInstanceId": "MyProcess_001",
      "lttd": 1546387230000,
      "startDate": 1546387200000,
      "endDate": 1546387250000,
      "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"
        }
      }
    }
  ],
  "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,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess",
    "ACTION"
  ],
  "actions": [
    {
      "type": "URL",
      "lockAction": true,
      "called": false,
      "updateStateBeforeAction": false,
      "hidden": true,
      "buttonStyle": "button.css",
      "label": {
        "key": "myCard.myAction.label",
        "parameters": {
          "EN": "My actions label",
          "FR": "Mon intitule d'actions"
        }
      }
    }
  ],
  "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"
    }
  }
}
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

[
  {
    "number": 3,
    "publishDate": 1546300800000,
    "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,
  "loadedCards": [
    "string"
  ]
}

Responses

CodeDescription
200

OK

{
  "rangeStart": 1551868290379,
  "rangeEnd": 1551868290379,
  "loadedCards": [
    "string"
  ]
}
400

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

401

Authentication required

404

Subscription not found

card

Publish one card to OperatorFabric

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,
  "severity": "ACTION",
  "tags": [
    "MyService",
    "MyProcess",
    "ACTION"
  ],
  "actions": [
    {
      "type": "URL",
      "lockAction": true,
      "called": false,
      "updateStateBeforeAction": false,
      "hidden": true,
      "buttonStyle": "button.css",
      "label": {
        "key": "myCard.myAction.label",
        "parameters": {
          "EN": "My actions label",
          "FR": "Mon intitule d'actions"
        }
      }
    }
  ],
  "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"
    }
  }
}

Responses

CodeDescription
201

created

{
  "id": "string",
  "uid": "string"
}
400

bad request

update

update current card users acknowledgements, 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, 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

acknowledgement

update current card users acknowledgements, 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 acknowledgements, removing an item, by card id and authenticated user

Parameters

NameDescription
uid *
string
(path)

The card uid

Responses

CodeDescription
200

Item removed

204

Try to remove unexisting item

404

Try to remove item from 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

Responses

CodeDescription
200

Item removed

204

Try to remove unexisting item

404

Try to remove item from unexisting card