--- title: "Get all remote callbacks of a fleet." method: GET path: "/fleets/{fid}/remote/callbacks" tags: ["Remote"] --- # Get all remote callbacks of a fleet. `GET /fleets/{fid}/remote/callbacks` ## Request - Base URL: `https://api-cert.groupe-psa.com/connectedcar/v3` - URL: `https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/remote/callbacks` - Auth: HTTP basic and API key in query parameter `client_id` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the list of subscribed remote callback of the fleet. ## Path parameters - `fid` string, required ## Query parameters - `types` RemoteType[] - `indexRange` string: Range index used to express the first (offset) and the last results index to retrieve. With the respect to the regex pattern '\d+(-\d*)?', the start of range is mandatory (use 0 for default). *Example:* * '0-9' : start=0, end=9 ==> offset=0 and number of items=10 * '5-' : start =5, no end ==> start at 5th to the end results. - `pageSize` integer - `pageToken` string ## Response `200` A list of subsribed remote callback. - RemoteCallbacks - `_links` TabLinks, required: [HAL](https://en.wikipedia.org/wiki/Hypertext_Application_Language#Convention) (Hypertext Application Language) link collection - `self` Link, required: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `first` Link, required: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `next` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `prev` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `last` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `total` integer, required - `totalPage` integer, required - `currentPage` integer, required - `_embedded` object, required - `callbacks` RemoteCallback[] - `_links` object, required: *Note*: ```remotes``` is a templated link. - `self` Link, required: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `fleet` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `remotes` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `id` string, required: Uniq remote callback ID returned when the callback was subscribed (created) succefuly. - `subscribe` RemoteCallbackSubscribe, required: Remote access callback subscription parameters. - `retryPolicy` object: The retry policy to apply when notification failed. - `policy` 'None' | 'Bounded', required: Defines the retry rules following a notification failure (ie the return code is not HTTP 2XX for WebHook mode). ```None``` means with a single try, ```Bounded``` with a limited number of tries. - `retryNumber` integer: Maximum number of attempts (to be used with a retryPolicy set to ```Bounded```). - `retryDelay` integer: Time to wait (expressed in seconds) before retrying to push a notification (ignored if retryPolicy is set to ```None```). - `batchNotify` object: Notification batch of events defined by a time window and batch size. If this field is not set, the callback will post only one event by call. * **At least, the ```size``` parameter should be provided.** * **If the time window is not set then the default value will be applied.** - `size` integer, required: Batch size (positive value and not zero). - `timeWindow` integer: Notification batch window size (expressed in seconds). - `callback` object, required - `webhook` object, required: Defines the webhook for htp notification . - `target` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `name` string, required: Webhook name. - `attributes` object[]: Additional attributes-set as key/value pairs wich will be added to the request when sending the event. It can be used as http header enhancement (such as headers can be used as an authentication parameter when posting the event) or simply added to the notification event body (as set of key/values) or finally as additional query parameters. - … - `label` string - `remoteTypes` RemoteType[], required - `status` 'Running' | 'Paused' | 'Failed', required ## Other responses - `default` (unresolved $ref) --- [API](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api.md) - [All operations](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/llms.txt) - [OpenAPI document](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/revisions/023ff3e3fe51?raw)