REST API for Oracle Fusion Cloud Financials

Get all asset books

get

/fscmRestApi/resources/11.13.18.05/fixedAssetBooksLOV

Request

Query Parameters

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
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- IntentFinder: Finds the asset books based on intent.
  Finder Variables:
  - Intent; string; Refers to a data security privilege.
- PrimaryKey: Finds an asset book that matches the specified book name.
  Finder Variables:
  - BookTypeCode; string; Name of the asset book.
- leaseCorpBooksFinder: Finds all corporate asset books with at least one lease.
  Finder Variables:
  - Intent; string; Refers to a data security privilege.
- ledgerRowFinder: Finds all asset books associated with the specified ledger.
  Finder Variables:
  - Name; string; Name of the ledger associated with the asset book.
- transferLeaseInvBooksFinder: Finds all corporate asset books with lease invoices to be transferred to Payables.
  Finder Variables:
  - Intent; string; Refers to a data security privilege.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
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
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- AllowPhysicalInventoryFlag; boolean; Indicates whether physical inventory is enabled for the asset book.
- BookClass; string; Classification of the asset book as either Corporate or Tax.
- BookTypeCode; string; Name of the asset book.
- CurrencyCode; string; Currency code of the asset book.
- DateIneffective; string; Date when the asset book becomes inactive.
- DeprnCalendar; string; Name of the depreciation calendar.
- GlPostingAllowedFlag; boolean; Option that indicates whether posting accounting entries to the ledger is enabled.
- Name; string; Name of the ledger.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

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.

Root Schema : fixedAssetBooksLOV

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/fixedAssetBooksLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object fixedAssetBooksLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/fixedAssetBooksLOV-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 : fixedAssetBooksLOV-item-response

Type: object

Show Source

AllowPhysicalInventoryFlag: boolean

Read Only: true

Maximum Length: 1

Indicates whether physical inventory is enabled for the asset book.
BookClass: string

Title: Book Class

Read Only: true

Maximum Length: 15

Classification of the asset book as either Corporate or Tax.
BookTypeCode: string

Title: Name

Read Only: true

Maximum Length: 30

Name of the asset book.
CurrencyCode: string

Read Only: true

Maximum Length: 15

Currency code of the asset book.
DateIneffective: string (date)

Title: Inactive On

Read Only: true

Date when the asset book becomes inactive.
DeprnCalendar: string

Title: Depreciation Calendar

Read Only: true

Maximum Length: 15

Name of the depreciation calendar.
GlPostingAllowedFlag: boolean

Title: Allow ledger posting

Read Only: true

Maximum Length: 3

Option that indicates whether posting accounting entries to the ledger is enabled.
links: array Links

Title: Links

The link relations associated with the resource instance.
Name: string

Title: Name

Read Only: true

Maximum Length: 30

Name of the ledger.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the asset book.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GlPostingAllowedFlag":{
            "title":"Allow ledger posting",
            "maxLength":3,
            "type":"boolean",
            "description":"Option that indicates whether posting accounting entries to the ledger is enabled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateIneffective":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the asset book becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BookTypeCode":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the asset book.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BookClass":{
            "title":"Book Class",
            "maxLength":15,
            "type":"string",
            "description":"Classification of the asset book as either Corporate or Tax.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowPhysicalInventoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether physical inventory is enabled for the asset book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeprnCalendar":{
            "title":"Depreciation Calendar",
            "maxLength":15,
            "type":"string",
            "description":"Name of the depreciation calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the ledger.",
            "nullable":false,
            "readOnly":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."
        }
    }
}