Jump to

• Request
• Response
• Examples

Update one source table

patch

/fscmRestApi/resources/11.13.18.05/spendClassificationAttributeSourceTables/{DatasetSourceTableId}

Request

Path Parameters

• DatasetSourceTableId(required): integer(int64)
  Unique identifier for source table.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdditionalJoinTable: string
  Maximum Length: 128

  Additional source table name that's used to derive the spend classification attribute.
• AliasName: string
  Maximum Length: 30

  Alias of the source table.
• DatasetName: string
  Maximum Length: 80

  Name of the data set.
• JoinCondition: string
  Maximum Length: 4000

  Join clause for the source table.
• TableName: string
  Maximum Length: 128

  Name of the source table.
• TableType: string
  Maximum Length: 80

  Value that determines if the source table entry is predefined.

{
    "type":"object",
    "properties":{
        "TableName":{
            "maxLength":128,
            "type":"string",
            "description":"Name of the source table.",
            "nullable":true
        },
        "TableType":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines if the source table entry is predefined.",
            "nullable":true
        },
        "DatasetName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the data set.",
            "nullable":false
        },
        "AliasName":{
            "maxLength":30,
            "type":"string",
            "description":"Alias of the source table.",
            "nullable":true
        },
        "AdditionalJoinTable":{
            "maxLength":128,
            "type":"string",
            "description":"Additional source table name that's used to derive the spend classification attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "JoinCondition":{
            "maxLength":4000,
            "type":"string",
            "description":"Join clause for the source table.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : spendClassificationAttributeSourceTables-item-response

Type: object

Show Source

• AdditionalJoinTable: string
  Maximum Length: 128

  Additional source table name that's used to derive the spend classification attribute.
• AliasName: string
  Maximum Length: 30

  Alias of the source table.
• DatasetDescription: string
  Read Only: true

  Maximum Length: 80

  Description of the data set.
• DatasetName: string
  Maximum Length: 80

  Name of the data set.
• DatasetSourceTableId: integer (int64)
  Unique identifier for source table.
• JoinCondition: string
  Maximum Length: 4000

  Join clause for the source table.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TableName: string
  Maximum Length: 128

  Name of the source table.
• TableType: string
  Maximum Length: 80

  Value that determines if the source table entry is predefined.

{
    "type":"object",
    "properties":{
        "TableName":{
            "maxLength":128,
            "type":"string",
            "description":"Name of the source table.",
            "nullable":true,
            "x-queryable":true
        },
        "TableType":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines if the source table entry is predefined.",
            "nullable":true,
            "x-queryable":true
        },
        "DatasetName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the data set.",
            "nullable":false,
            "x-queryable":true
        },
        "AliasName":{
            "maxLength":30,
            "type":"string",
            "description":"Alias of the source table.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalJoinTable":{
            "maxLength":128,
            "type":"string",
            "description":"Additional source table name that's used to derive the spend classification attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DatasetSourceTableId":{
            "type":"integer",
            "description":"Unique identifier for source table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DatasetDescription":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the data set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JoinCondition":{
            "maxLength":4000,
            "type":"string",
            "description":"Join clause for the source table.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Examples

This example describes how to update one source table.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/spendClassificationAttributeSourceTables/DatasetSourceTableId"

Example Request Body

The following example includes the contents of the request body in JSON format to update a source table that can be used for mapping the columns to additional attributes. This example illustrates how a source table is updated by providing the alias name.

You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
	"AliasName": "ProjectTask1"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"DatasetSourceTableId": 444,
	"DatasetName": "ORA_POI_ORDERS",
	"TableName": "PJF_PROJ_ELEMENTS_VL",
	"AliasName": "ProjectTask1",
	"JoinCondition": "POD.PJC_TASK_ID = ProjectTask.PROJ_ELEMENT_ID (+)",
	"TableType": "ORA_POI_STANDARD",
	"AdditionalJoinTable": null,
                  "links": [
                    . . .
                   ]
}

Back to Top