Jump to

• Request
• Response

Get a consumer row

get

/fscmRestApi/resources/11.13.18.05/dataGetterConsumers/{ConsumerId}

Request

Path Parameters

• ConsumerId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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(required):
  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(required):
  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 : dataGetterConsumers-item-response

Type: object

Show Source

• ConsumerCode: string
  Title: Consumer Code

  Maximum Length: 50

  Data selection tool consumer unique code, such as COMM, RULES, or ADMISSIONS.
• ConsumerId: integer (int64)
  Title: Consumer ID

  Data selection tool consumer unique identifier.
• ConsumerName: string
  Title: Consumer Name

  Maximum Length: 100

  Name of the data selection tool consumer, such as the Fee discount calculation process.
• ConsumerTypeCode: string
  Title: Consumer Type Code

  Maximum Length: 30

  Type of the data selection tool consumer, for example, a process or a transaction. A list of accepted values is defined in the lookup type ORA_HEY_CONSUMER_TYPE_CODE.
• dataGetterConsumerProfileMappings: array Data Selection Tool Consumer Profile Mappings
  Title: Data Selection Tool Consumer Profile Mappings

  The data selection tool consumer profile mappings resource provides a list of artifact data profiles mapped to a data selection tool consumer.
• dataGetterConsumerToolMappings: array Data Selection Tool Consumer Tool Mappings
  Title: Data Selection Tool Consumer Tool Mappings

  The data selection tool consumer tool mappings resource provides a list of selection tools mapped for a data selection tool consumer.
• DataProfileUsageTypeCode: string
  Title: Data Profile Usage Type Code

  Maximum Length: 30

  Data profile usage type code that a data selection tool consumer has access to, for example, all profiles or consumer specific profiles. A list of accepted values is defined in the lookup type ORA_HEY_DATA_PROFILE_USE.
• DefaultQueryOwnershipFlag: boolean
  Title: Default Query Ownership

  Maximum Length: 1

  Indicates if the data selection tool consumer can own a query by default or not.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the data selection tool consumer.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReferenceAttributeName: string
  Title: Reference Attribute Name

  Maximum Length: 128

  Data selection tool consumer source table attribute name in which query usage reference ID is stored.
• SelectAllColumnsFlag: boolean
  Title: Select All Columns

  Maximum Length: 1

  Indicates if all columns of the view objects need to be selected by default or not in query creation UI flows.
• SourceTableName: string
  Title: Source Table Name

  Maximum Length: 128

  Data selection tool consumer source table name. Used to scan for orphan query usage entries. These entries indicate queries for which usage is unknown.

{
    "type":"object",
    "properties":{
        "SourceTableName":{
            "title":"Source Table Name",
            "maxLength":128,
            "type":"string",
            "description":"Data selection tool consumer source table name. Used to scan for orphan query usage entries. These entries indicate queries for which usage is unknown.",
            "nullable":false,
            "x-queryable":true
        },
        "ConsumerTypeCode":{
            "title":"Consumer Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Type of the data selection tool consumer, for example, a process or a transaction. A list of accepted values is defined in the lookup type ORA_HEY_CONSUMER_TYPE_CODE.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the data selection tool consumer.",
            "nullable":true,
            "x-queryable":true
        },
        "ConsumerCode":{
            "title":"Consumer Code",
            "maxLength":50,
            "type":"string",
            "description":"Data selection tool consumer unique code, such as COMM, RULES, or ADMISSIONS.",
            "nullable":false,
            "x-queryable":true
        },
        "DataProfileUsageTypeCode":{
            "title":"Data Profile Usage Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Data profile usage type code that a data selection tool consumer has access to, for example, all profiles or consumer specific profiles. A list of accepted values is defined in the lookup type ORA_HEY_DATA_PROFILE_USE.",
            "nullable":false,
            "x-queryable":true
        },
        "dataGetterConsumerToolMappings":{
            "title":"Data Selection Tool Consumer Tool Mappings",
            "type":"array",
            "description":"The data selection tool consumer tool mappings resource provides a list of selection tools mapped for a data selection tool consumer.",
            "items":{
                "$ref":"#/components/schemas/dataGetterConsumers-dataGetterConsumerToolMappings-item-response"
            }
        },
        "ConsumerName":{
            "title":"Consumer Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the data selection tool consumer, such as the Fee discount calculation process.",
            "nullable":false,
            "x-queryable":true
        },
        "SelectAllColumnsFlag":{
            "title":"Select All Columns",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if all columns of the view objects need to be selected by default or not in query creation UI flows.",
            "nullable":false,
            "x-queryable":true
        },
        "dataGetterConsumerProfileMappings":{
            "title":"Data Selection Tool Consumer Profile Mappings",
            "type":"array",
            "description":"The data selection tool consumer profile mappings resource provides a list of artifact data profiles mapped to a data selection tool consumer.",
            "items":{
                "$ref":"#/components/schemas/dataGetterConsumers-dataGetterConsumerProfileMappings-item-response"
            }
        },
        "DefaultQueryOwnershipFlag":{
            "title":"Default Query Ownership",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the data selection tool consumer can own a query by default or not.",
            "nullable":false,
            "x-queryable":true
        },
        "ConsumerId":{
            "title":"Consumer ID",
            "type":"integer",
            "description":"Data selection tool consumer unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReferenceAttributeName":{
            "title":"Reference Attribute Name",
            "maxLength":128,
            "type":"string",
            "description":"Data selection tool consumer source table attribute name in which query usage reference ID is stored.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Data Selection Tool Consumer Profile Mappings

Type: array

Title: Data Selection Tool Consumer Profile Mappings

The data selection tool consumer profile mappings resource provides a list of artifact data profiles mapped to a data selection tool consumer.

Show Source

• Array of: object dataGetterConsumers-dataGetterConsumerProfileMappings-item-response

{
    "title":"Data Selection Tool Consumer Profile Mappings",
    "type":"array",
    "description":"The data selection tool consumer profile mappings resource provides a list of artifact data profiles mapped to a data selection tool consumer.",
    "items":{
        "$ref":"#/components/schemas/dataGetterConsumers-dataGetterConsumerProfileMappings-item-response"
    }
}

Nested Schema : Data Selection Tool Consumer Tool Mappings

Type: array

Title: Data Selection Tool Consumer Tool Mappings

The data selection tool consumer tool mappings resource provides a list of selection tools mapped for a data selection tool consumer.

Show Source

• Array of: object dataGetterConsumers-dataGetterConsumerToolMappings-item-response

{
    "title":"Data Selection Tool Consumer Tool Mappings",
    "type":"array",
    "description":"The data selection tool consumer tool mappings resource provides a list of selection tools mapped for a data selection tool consumer.",
    "items":{
        "$ref":"#/components/schemas/dataGetterConsumers-dataGetterConsumerToolMappings-item-response"
    }
}

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 : dataGetterConsumers-dataGetterConsumerProfileMappings-item-response

Type: object

Show Source

• ArtifactGroupId: integer (int64)
  Title: Artifact Group ID

  Data profile identifier associated with a data selection consumer and selection tool combination. Data profile is a type of data artifact group.
• ConsumerProfileMappingId: integer (int64)
  Title: Consumer Profile Mapping ID

  Data selection tool consumer profile mapping unique identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SelectionToolId: integer (int64)
  Title: Selection Tool ID

  Data selection tool unique identifier.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConsumerProfileMappingId":{
            "title":"Consumer Profile Mapping ID",
            "type":"integer",
            "description":"Data selection tool consumer profile mapping unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ArtifactGroupId":{
            "title":"Artifact Group ID",
            "type":"integer",
            "description":"Data profile identifier associated with a data selection consumer and selection tool combination. Data profile is a type of data artifact group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SelectionToolId":{
            "title":"Selection Tool ID",
            "type":"integer",
            "description":"Data selection tool unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Nested Schema : dataGetterConsumers-dataGetterConsumerToolMappings-item-response

Type: object

Show Source

• ArtifactGroupTypeCode: string
  Title: Artifact Group Type Code

  Read Only: true

  Maximum Length: 30

  Artifact group type code that's associated with a data selection tool.
• ConsumerToolMappingId: integer (int64)
  Title: Consumer Tool Mapping ID

  Data selection tool consumer and tool mapping unique identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SelectionToolCode: string
  Title: Selection Tool Code

  Read Only: true

  Maximum Length: 30

  Data selection tool unique code.
• SelectionToolId: integer (int64)
  Title: Selection Tool ID

  Data selection tool unique identifier.
• SelectionToolName: string
  Title: Selection Tool Name

  Read Only: true

  Maximum Length: 100

  Name of the data selection tool.

{
    "type":"object",
    "properties":{
        "SelectionToolName":{
            "title":"Selection Tool Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the data selection tool.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumerToolMappingId":{
            "title":"Consumer Tool Mapping ID",
            "type":"integer",
            "description":"Data selection tool consumer and tool mapping unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ArtifactGroupTypeCode":{
            "title":"Artifact Group Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Artifact group type code that's associated with a data selection tool.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SelectionToolCode":{
            "title":"Selection Tool Code",
            "maxLength":30,
            "type":"string",
            "description":"Data selection tool unique code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SelectionToolId":{
            "title":"Selection Tool ID",
            "type":"integer",
            "description":"Data selection tool unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

Links

dataGetterConsumerProfileMappings

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterConsumers/{ConsumerId}/child/dataGetterConsumerProfileMappings

Parameters:

• ConsumerId: $request.path.ConsumerId

The data selection tool consumer profile mappings resource provides a list of artifact data profiles mapped to a data selection tool consumer.

dataGetterConsumerToolMappings

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterConsumers/{ConsumerId}/child/dataGetterConsumerToolMappings

Parameters:

• ConsumerId: $request.path.ConsumerId

The data selection tool consumer tool mappings resource provides a list of selection tools mapped for a data selection tool consumer.

Back to Top