Jump to

• Request
• Response

Get a drillback value

get

/fscmRestApi/resources/11.13.18.05/publicSectorBnpDrillbacks/{publicSectorBnpDrillbacksUniqID}

Request

Path Parameters

• publicSectorBnpDrillbacksUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- BnpDrillbackType and Classification ---for the Billing and Payment Drillbacks resource and used to uniquely identify an instance of Billing and Payment Drillbacks. The client should not generate the hash key value. Instead, the client should query on the Billing and Payment Drillbacks collection resource with a filter on the primary key values in order to navigate to a specific instance of Billing and Payment Drillbacks.
  
  For example: publicSectorBnpDrillbacks?q=BnpDrillbackType=<value1>;Classification=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorBnpDrillbacks-item-response

Type: object

Show Source

• BnpDrillbackType: string
  Maximum Length: 30

  Indicates whether the drillback record applies to a billing transaction or a payment transaction.
• Classification: string
  Maximum Length: 30

  The source application code associated with the drillback record.
• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the record is logically deleted.
• EncodeFlag: string
  Maximum Length: 1

  Indicates whether the source requires all context keys encoded prior to drillback.
• FifthContextAlias: string
  Maximum Length: 30

  Alias for the fifth context key.
• FifthContextKey: string
  Maximum Length: 30

  Fifth context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.
• FourthContextAlias: string
  Maximum Length: 30

  Alias for the fourth context key.
• FourthContextKey: string
  Maximum Length: 30

  Fourth context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MainContextAlias: string
  Maximum Length: 30

  Alias for the first context key.
• MainContextKey: string
  Maximum Length: 30

  First context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.
• PscnvItemName: string
  Maximum Length: 30

  Navigation item name of the drill back page.
• PscnvRegName: string
  Maximum Length: 30

  Navigation registry name of the drill back component.
• SecondContextAlias: string
  Maximum Length: 30

  Alias for the second context key.
• SecondContextKey: string
  Maximum Length: 30

  Second context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.
• ThirdContextAlias: string
  Maximum Length: 30

  Alias for the third context key.
• ThirdContextKey: string
  Maximum Length: 30

  Third context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.

{
    "type":"object",
    "properties":{
        "MainContextAlias":{
            "maxLength":"30",
            "type":"string",
            "description":"Alias for the first context key.",
            "nullable":true,
            "x-queryable":true
        },
        "FourthContextAlias":{
            "maxLength":"30",
            "type":"string",
            "description":"Alias for the fourth context key.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdContextAlias":{
            "maxLength":"30",
            "type":"string",
            "description":"Alias for the third context key.",
            "nullable":true,
            "x-queryable":true
        },
        "FourthContextKey":{
            "maxLength":"30",
            "type":"string",
            "description":"Fourth context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.",
            "nullable":true,
            "x-queryable":true
        },
        "FifthContextKey":{
            "maxLength":"30",
            "type":"string",
            "description":"Fifth context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.",
            "nullable":true,
            "x-queryable":true
        },
        "EncodeFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the source requires all context keys encoded prior to drillback.",
            "nullable":true,
            "x-queryable":true
        },
        "MainContextKey":{
            "maxLength":"30",
            "type":"string",
            "description":"First context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.",
            "nullable":true,
            "x-queryable":true
        },
        "PscnvRegName":{
            "maxLength":"30",
            "type":"string",
            "description":"Navigation registry name of the drill back component.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"30",
            "type":"string",
            "description":"The source application code associated with the drillback record.",
            "nullable":false,
            "x-queryable":true
        },
        "PscnvItemName":{
            "maxLength":"30",
            "type":"string",
            "description":"Navigation item name of the drill back page.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted.",
            "nullable":false,
            "x-queryable":true
        },
        "FifthContextAlias":{
            "maxLength":"30",
            "type":"string",
            "description":"Alias for the fifth context key.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SecondContextKey":{
            "maxLength":"30",
            "type":"string",
            "description":"Second context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdContextKey":{
            "maxLength":"30",
            "type":"string",
            "description":"Third context key identifiable by the source application to display the drillback page. The key value should be available in the corresponding BNP transaction type table.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondContextAlias":{
            "maxLength":"30",
            "type":"string",
            "description":"Alias for the second context key.",
            "nullable":true,
            "x-queryable":true
        },
        "BnpDrillbackType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the drillback record applies to a billing transaction or a payment transaction.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top