Jump to

• Request
• Response

Get an artifact statement

get

/fscmRestApi/resources/11.13.18.05/artifactStatements/{StatementId}

Request

Path Parameters

• StatementId(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:
  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 : artifactStatements-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Status

  Maximum Length: 1

  Default Value: true

  Indicates whether a resource is active or inactive. The default value is Y.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of an artifact statement.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LogicLevelCode: string
  Title: Logic Level Code

  Maximum Length: 30

  The logic level of the statement, for example, simple logic or complex logic. A list of accepted values is defined in the lookup type ORA_HEY_LOGIC_LEVEL_CODE.
• LogicLevelMeaning: string
  Title: Logic Level

  Read Only: true

  Maximum Length: 80

  The meaning of the logic level code. A list of accepted values is defined in the lookup type ORA_HEY_LOGIC_LEVEL_CODE.
• StatementCode: string
  Title: Statement Code

  Maximum Length: 50

  The artifact statement unique code, such as IF or ALL.
• StatementId: integer (int64)
  Title: Statement ID

  The unique identifier of an artifact statement.
• StatementName: string
  Title: Name

  Maximum Length: 50

  The name of an artifact statement.
• StatementSubtypeCode: string
  Title: Statement Subtype Code

  Maximum Length: 30

  The subtype of the statement, for example, calculate or operator. A list of accepted values is defined in the lookup type ORA_HEY_STATEMENT_SUBTYPE_CODE.
• StatementSubtypeMeaning: string
  Title: Statement Subtype

  Read Only: true

  Maximum Length: 80

  The meaning of the statement subtype code. A list of accepted values is defined in the lookup type ORA_HEY_STATEMENT_SUBTYPE_CODE.
• StatementTypeCode: string
  Title: Statement Type Code

  Maximum Length: 30

  The type of the statement, for example, math, function or logic. A list of accepted values is defined in the lookup type ORA_HEY_STATEMENT_TYPE_CODE.
• StatementTypeMeaning: string
  Title: Statement Type

  Read Only: true

  Maximum Length: 80

  The meaning of the statement type code. A list of accepted values is defined in the lookup type ORA_HEY_STATEMENT_TYPE_CODE.

{
    "type":"object",
    "properties":{
        "StatementName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of an artifact statement.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of an artifact statement.",
            "nullable":true,
            "x-queryable":true
        },
        "LogicLevelCode":{
            "title":"Logic Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"The logic level of the statement, for example, simple logic or complex logic. A list of accepted values is defined in the lookup type ORA_HEY_LOGIC_LEVEL_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatementId":{
            "title":"Statement ID",
            "type":"integer",
            "description":"The unique identifier of an artifact statement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatementTypeCode":{
            "title":"Statement Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the statement, for example, math, function or logic. A list of accepted values is defined in the lookup type ORA_HEY_STATEMENT_TYPE_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatementTypeMeaning":{
            "title":"Statement Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the statement type code. A list of accepted values is defined in the lookup type ORA_HEY_STATEMENT_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StatementCode":{
            "title":"Statement Code",
            "maxLength":"50",
            "type":"string",
            "description":"The artifact statement unique code, such as IF or ALL.",
            "nullable":false,
            "x-queryable":true
        },
        "StatementSubtypeCode":{
            "title":"Statement Subtype Code",
            "maxLength":"30",
            "type":"string",
            "description":"The subtype of the statement, for example, calculate or operator. A list of accepted values is defined in the lookup type ORA_HEY_STATEMENT_SUBTYPE_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatementSubtypeMeaning":{
            "title":"Statement Subtype",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the statement subtype code. A list of accepted values is defined in the lookup type ORA_HEY_STATEMENT_SUBTYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LogicLevelMeaning":{
            "title":"Logic Level",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the logic level code. A list of accepted values is defined in the lookup type ORA_HEY_LOGIC_LEVEL_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Status",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a resource is active or inactive. The default value is Y.",
            "nullable":false,
            "default":true,
            "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."
        }
    }
}

Links

HeyCommonServiceAM_HeyLookup1_1

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_LOGIC_LEVEL_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: LogicLevelCode; Target Attribute: LookupCode
• Display Attribute: Meaning

HeyCommonServiceAM_HeyLookup1_2

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_STATEMENT_TYPE_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: StatementTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

HeyCommonServiceAM_HeyLookup1_3

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_STATEMENT_SUBTYPE_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: StatementSubtypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top