Jump to

• Request
• Response

Get metadata for one document definition

get

/fscmRestApi/resources/11.13.18.05/collaborationDocumentMetadata/{DocumentTypeCode}

Request

Path Parameters

• DocumentTypeCode(required): string
  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 : collaborationDocumentMetadata-item-response

Type: object

Show Source

• CustomerLevelCode: string
  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.
• documentMeasureMetadata: array Document Measure Metadata
  Title: Document Measure Metadata

  The Document Measure Metadata resource gets the metadata for measures associated with a document definition.
• DocumentMetadataId: integer (int64)
  Read Only: true

  Value that uniquely identifies the document metadata.
• DocumentTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of document used for collaboration.
• DocumentTypeName: string
  Read Only: true

  Maximum Length: 80

  Type of document used for collaboration.
• ItemLevelCode: string
  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.
• ItemResolutionCode: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationLevelCode: string
  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.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the current state of the document definition.

{
    "type":"object",
    "properties":{
        "ItemLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the item level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ITEM.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemResolutionCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the organization level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ORGANIZATION.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the customer level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_CUSTOMER.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of document used for collaboration.",
            "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"
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the current state of the document definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentMetadataId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document metadata.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentTypeName":{
            "maxLength":80,
            "type":"string",
            "description":"Type of document used for collaboration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "documentMeasureMetadata":{
            "title":"Document Measure Metadata",
            "type":"array",
            "description":"The Document Measure Metadata resource gets the metadata for measures associated with a document definition.",
            "items":{
                "$ref":"#/components/schemas/collaborationDocumentMetadata-documentMeasureMetadata-item-response"
            }
        }
    }
}

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

• Array of: object collaborationDocumentMetadata-documentMeasureMetadata-item-response

{
    "title":"Document Measure Metadata",
    "type":"array",
    "description":"The Document Measure Metadata resource gets the metadata for measures associated with a document definition.",
    "items":{
        "$ref":"#/components/schemas/collaborationDocumentMetadata-documentMeasureMetadata-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 : collaborationDocumentMetadata-documentMeasureMetadata-item-response

Type: object

Show Source

• CurrentCycleFlag: boolean
  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.
• DisplayName: string
  Read Only: true

  Maximum Length: 80

  Name of the type of displayed measure used for collaboration.
• DocumentMeasureMetadataId: integer
  Read Only: true

  Value that uniquely identifies the document measure metadata.
• EditStartDate: string (date)
  Read Only: true

  Date that identifies the measure's first editable time bucket.
• EndDate: string (date)
  Read Only: true

  Date that identifies the measure's last time bucket.
• ExpiringMeasureFlag: boolean
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of measure used for collaboration.
• ParticipantOwnerCode: string
  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.
• ParticipantOwnerName: string
  Read Only: true

  Maximum Length: 80

  Name of the measure's owning participant.
• Sequence: number
  Read Only: true

  Sequence to use to identify the document measure.
• StartDate: string (date)
  Read Only: true

  Date that identifies the measure's first time bucket.
• TimeSeriesFlag: boolean
  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.

{
    "type":"object",
    "properties":{
        "TimeSeriesFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantOwnerName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the measure's owning participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentMeasureMetadataId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document measure metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of measure used for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Sequence":{
            "type":"number",
            "description":"Sequence to use to identify the document measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EditStartDate":{
            "type":"string",
            "description":"Date that identifies the measure's first editable time bucket.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"Date that identifies the measure's last time bucket.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Date that identifies the measure's first time bucket.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantOwnerCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the measure's participant owner. Displayed value is either ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentCycleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of displayed measure used for collaboration.",
            "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"
            }
        },
        "ExpiringMeasureFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "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."
        }
    }
}

Links

documentMeasureMetadata

Operation: /fscmRestApi/resources/11.13.18.05/collaborationDocumentMetadata/{DocumentTypeCode}/child/documentMeasureMetadata

Parameters:

• DocumentTypeCode: $request.path.DocumentTypeCode

The Document Measure Metadata resource gets the metadata for measures associated with a document definition.

Back to Top