1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Collaboration Document Metadata

Get metadata for all document definitions

get

/fscmRestApi/resources/11.13.18.05/collaborationDocumentMetadata

Request

Query Parameters
  • 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).
  • 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
  • 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

    • PrimaryKey Find document measure metadata according to the primary key criteria.
      Finder Variables
      • DocumentMetadataId; integer; Value that uniquely identifies the document metadata.
      • DocumentTypeCode; string; Abbreviation that identifies the type of document used for collaboration.
    • RowFinder Find collaboration document metadata according to the primary key criteria.
      Finder Variables
      • DocumentTypeCode; string; Abbreviation that identifies the type of document used for collaboration.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CustomerLevelCode; string; Abbreviation that identifies the customer level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_CUSTOMER.
    • DocumentMetadataId; integer; Value that uniquely identifies the document metadata.
    • DocumentTypeCode; string; Abbreviation that identifies the type of document used for collaboration.
    • DocumentTypeName; string; Type of document used for collaboration.
    • ItemLevelCode; string; Abbreviation that identifies the item level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ITEM.
    • ItemResolutionCode; string; Abbreviation that identifies the item name resolution when the item level code is ORA_ITEM. A list of accepted values is defined in the lookup type ORA_VCS_ITEM_RESOLUTION.
    • OrganizationLevelCode; string; Abbreviation that identifies the organization level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ORGANIZATION.
    • StatusCode; string; Abbreviation that identifies the current state of the document definition.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : collaborationDocumentMetadata
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : collaborationDocumentMetadata-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the customer level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_CUSTOMER.
  • Document Measure Metadata
    Title: Document Measure Metadata
    The Document Measure Metadata resource gets the metadata for measures associated with a document definition.
  • Read Only: true
    Value that uniquely identifies the document metadata.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of document used for collaboration.
  • Read Only: true
    Maximum Length: 80
    Type of document used for collaboration.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the item level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ITEM.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the item name resolution when the item level code is ORA_ITEM. A list of accepted values is defined in the lookup type ORA_VCS_ITEM_RESOLUTION.
  • Links
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the organization level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ORGANIZATION.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the current state of the document definition.
Nested Schema : Document Measure Metadata
Type: array
Title: Document Measure Metadata
The Document Measure Metadata resource gets the metadata for measures associated with a document definition.
Show Source
Nested Schema : collaborationDocumentMetadata-documentMeasureMetadata-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the measure quantities are in the current planning cycle. If false, then the measure quantities have been expired and are in the previous planning cycle. This attribute doesn't have a default value.
  • Read Only: true
    Maximum Length: 80
    Name of the type of displayed measure used for collaboration.
  • Read Only: true
    Value that uniquely identifies the document measure metadata.
  • Read Only: true
    Date that identifies the measure's first editable time bucket.
  • Read Only: true
    Date that identifies the measure's last time bucket.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the measure data can be expired. This attribute doesn't have a default value.
  • Links
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of measure used for collaboration.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the measure's participant owner. Displayed value is either ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
  • Read Only: true
    Maximum Length: 80
    Name of the measure's owning participant.
  • Read Only: true
    Sequence to use to identify the document measure.
  • Read Only: true
    Date that identifies the measure's first time bucket.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the measure is a time series measure. If false, then the measure isn't a time series measure. This attribute doesn't have a default value.
Back to Top

Examples

This example describes how to get the metadata for document definitions that are configured for collaboration.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationDocumentMetadata"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationDocumentMetadata?q=DocumentTypeName='Consumption'&expand=all&onlyData=true"

Example Response Body

The following shows an example of the response body in JSON format.
{
    "items": [
        {
            "DocumentMetadataId": -10002,
            "DocumentTypeCode": "VCS_CONSUMPTION",
            "DocumentTypeName": "Consumption",
            "StatusCode": "A",
            "CustomerLevelCode": "ORA_VCS_CUSTOMER_SITE",
            "OrganizationLevelCode": "ORA_VCS_ORGANIZATION",
            "ItemLevelCode": "ORA_VCS_ITEM",
            "ItemResolutionCode": "ORA_VCS_ITEM_NUM",
            "documentMeasureMetadata": {
                "items": [
                    {
                        "DocumentMeasureMetadataId": -11004,
                        "MeasureTypeCode": "HISTORY",
                        "DisplayName": "History",
                        "Sequence": 300,
                        "CurrentCycleFlag": true,
                        "StartDate": "2019-09-01",
                        "EditStartDate": "2019-09-01",
                        "EndDate": "2021-08-31",
                        "ParticipantOwnerCode": "ORA_VCS_CUSTOMER",
                        "ParticipantOwnerName": "Customer",
                        "ExpiringMeasureFlag": false,
                        "@context": {
                            "key": "-11004"
                        }
                    }
                ],
                "count": 1,
                "hasMore": false,
                "limit": 25,
                "offset": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDocumentMetadata/VCS_CONSUMPTION/child/documentMeasureMetadata",
                        "name": "documentMeasureMetadata",
                        "kind": "collection"
                    }
                ]
            },
            "@context": {
                "key": "VCS_CONSUMPTION"
            }
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/collaborationDocumentMetadata",
            "name": "collaborationDocumentMetadata",
            "kind": "collection"
        }
    ]
}
Back to Top