Get Publish Subscribe Reasons

Describes the API specifications for retrieving Publish Subscribe reasons.

Request

URI: https://<SAP Fieldglass envionment URL>/api/v1/admin/v1/pubsub-reasons/<pubsub-reasonID>

HTTP Method: GET

Request Parameters

Parameter Required Data Type Description Parameter Type
pubsub-reasonID Yes String The unique ID of the Publish Subscribe Reason. Path

Request Example

GET https://company.com/api/v1/admin/v1/pubsub-reasons/012504052020193051353099
authorization: Bearer WDXlKj3TTOn3rpg9GHnZpbKmvj1=
x-ApplicationKey: 5c91f4fdb0c6ee9992ff476f89bf6cf25e589350
content-type: application/json

Response

Response Status and Error Codes

See Common Status and Error Codes for more information.

Response Body

Response Payload Content
Element Name Data Type Description
activeFlag Boolean Indicates whether the Publish Subscribe Reason record is active.
companyCode String Code describing the Business Unit.
createTime String The date and time the records was created.
description String A description of the Publish Subscribe Reason.
id String The unique ID of the Publish Subscribe Reason.
mspFeeApplicableFlag Boolean Indicates whether an MSP Fee is applicable to a Publish Subscribe Reason.
revisionTime String  
taxFlag Boolean Indicates whether a tax adjustment is applied when invoiced.
unit String  
value String  
Response Payload Links
Element Name Data Type Description
rel String Related sub-modules.
link String The URI of the link.
id String Globally unique database-level identifier of the Publish Subscribe Reason record.

Response Example

{
    "header": {
        "server": "Fieldglass API Server",
        "responseStatus": "OK",
        "noOfRecordsPresent": 1,
        "noOfRecordsServed": 1,
        "moreRecordsExists": false,
        "localeString": "en_US",
        "version": "v1"
    },
    "responsePayload": {
        "content": {
            "activeFlag": false,
            "companyCode": "ANTE",
            "createTime": "08/06/2007 15:49",
            "description": " aaaaaaaq",
            "id": "012504052020193051353099",
            "mspFeeApplicableFlag": false,
            "revisionTime": "12/09/2016 05:46",
            "taxFlag": false,
            "unit": 1,
            "value": "0"
        },
        "links": [
            {
                "rel": "self",
                "link": "api/v1/admin/v1/pubsub-reasons/012504052020193051353099",
                "id": "012504052020193051353099"
            }
        ]
    }
}