Jump to

• Request
• Response

Update a measure

patch

/fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}/child/measures/{DocumentMeasureId}

Request

Path Parameters

• DocumentId(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=
• DocumentMeasureId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• measureActions: array Measure Actions
  Title: Measure Actions

  The Measure Actions resource manages the actions associated with a document measure.
• measureParameters: array Measure Parameters
  Title: Measure Parameters

  The Measure Parameters resource manages the parameters associated with the document measures.
• ParticipantOwnerCode: string
  Maximum Length: 30

  Abbreviation that identifies the measure's participant owner. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.

{
    "type":"object",
    "properties":{
        "ParticipantOwnerCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the measure's participant owner. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.",
            "nullable":true
        },
        "measureActions":{
            "title":"Measure Actions",
            "type":"array",
            "description":"The Measure Actions resource manages the actions associated with a document measure.",
            "items":{
                "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureActions-item-patch-request"
            }
        },
        "measureParameters":{
            "title":"Measure Parameters",
            "type":"array",
            "description":"The Measure Parameters resource manages the parameters associated with the document measures.",
            "items":{
                "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureParameters-item-patch-request"
            }
        }
    }
}

Nested Schema : Measure Actions

Type: array

Title: Measure Actions

The Measure Actions resource manages the actions associated with a document measure.

Show Source

• Array of: object collaborationDocumentDefinitions-measures-measureActions-item-patch-request

{
    "title":"Measure Actions",
    "type":"array",
    "description":"The Measure Actions resource manages the actions associated with a document measure.",
    "items":{
        "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureActions-item-patch-request"
    }
}

Nested Schema : Measure Parameters

Type: array

Title: Measure Parameters

The Measure Parameters resource manages the parameters associated with the document measures.

Show Source

• Array of: object collaborationDocumentDefinitions-measures-measureParameters-item-patch-request

{
    "title":"Measure Parameters",
    "type":"array",
    "description":"The Measure Parameters resource manages the parameters associated with the document measures.",
    "items":{
        "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureParameters-item-patch-request"
    }
}

Nested Schema : collaborationDocumentDefinitions-measures-measureActions-item-patch-request

Type: object

Show Source

• measureActionParticipants: array Measure Action Participants
  Title: Measure Action Participants

  The Measure Action Participants resource manages the participants associated with an action.

{
    "type":"object",
    "properties":{
        "measureActionParticipants":{
            "title":"Measure Action Participants",
            "type":"array",
            "description":"The Measure Action Participants resource manages the participants associated with an action.",
            "items":{
                "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-patch-request"
            }
        }
    }
}

Nested Schema : Measure Action Participants

Type: array

Title: Measure Action Participants

The Measure Action Participants resource manages the participants associated with an action.

Show Source

• Array of: object collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-patch-request

{
    "title":"Measure Action Participants",
    "type":"array",
    "description":"The Measure Action Participants resource manages the participants associated with an action.",
    "items":{
        "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-patch-request"
    }
}

Nested Schema : collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-patch-request

Type: object

Show Source

• ParticipantCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
• ParticipantName: string
  Maximum Length: 255

  Name of the participant for an action.

{
    "type":"object",
    "properties":{
        "ParticipantName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the participant for an action.",
            "nullable":true
        },
        "ParticipantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.",
            "nullable":false
        }
    }
}

Nested Schema : collaborationDocumentDefinitions-measures-measureParameters-item-patch-request

Type: object

Show Source

• ParameterValue: string
  Maximum Length: 255

  Value of the parameter of the document measure.
• SecondParameterValue: string
  Maximum Length: 255

  Second value of the parameter of the document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_BOUNDARY_TYPE when the ParameterCode is MEASURE_HISTORY, MEASURE_HORIZON, or LOCKED_FENCE.

{
    "type":"object",
    "properties":{
        "ParameterValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the parameter of the document measure.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SecondParameterValue"
                ]
            }
        },
        "SecondParameterValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Second value of the parameter of the document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_BOUNDARY_TYPE when the ParameterCode is MEASURE_HISTORY, MEASURE_HORIZON, or LOCKED_FENCE.",
            "nullable":true
        }
    }
}

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 : collaborationDocumentDefinitions-measures-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the document measure.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the document measure.
• DataTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of measure data.
• DocumentMeasureId: integer (int64)
  Read Only: true

  Value that uniquely identifies the document measure.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the document measure.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the document measure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• measureActions: array Measure Actions
  Title: Measure Actions

  The Measure Actions resource manages the actions associated with a document measure.
• MeasureId: integer (int64)
  Value that uniquely identifies the measure definition.
• measureParameters: array Measure Parameters
  Title: Measure Parameters

  The Measure Parameters resource manages the parameters associated with the document measures.
• MeasureTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of measure used for collaboration.
• MeasureTypeName: string
  Name of the type of measure used for collaboration.
• ParticipantOwnerCode: string
  Maximum Length: 30

  Abbreviation that identifies the measure's participant owner. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
• ParticipantOwnerName: string
  Read Only: true

  Maximum Length: 80

  Name of the measure's owning participant.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the document measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the document measure.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the document measure.",
            "nullable":false,
            "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
        },
        "MeasureTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of measure used for collaboration.",
            "nullable":false,
            "x-queryable":true
        },
        "measureParameters":{
            "title":"Measure Parameters",
            "type":"array",
            "description":"The Measure Parameters resource manages the parameters associated with the document measures.",
            "items":{
                "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureParameters-item-response"
            }
        },
        "MeasureTypeName":{
            "type":"string",
            "description":"Name of the type of measure used for collaboration.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantOwnerCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the measure's participant owner. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.",
            "nullable":true,
            "x-queryable":true
        },
        "MeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentMeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "measureActions":{
            "title":"Measure Actions",
            "type":"array",
            "description":"The Measure Actions resource manages the actions associated with a document measure.",
            "items":{
                "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureActions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DataTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of measure data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the document measure.",
            "format":"date-time",
            "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 : Measure Actions

Type: array

Title: Measure Actions

The Measure Actions resource manages the actions associated with a document measure.

Show Source

• Array of: object collaborationDocumentDefinitions-measures-measureActions-item-response

{
    "title":"Measure Actions",
    "type":"array",
    "description":"The Measure Actions resource manages the actions associated with a document measure.",
    "items":{
        "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureActions-item-response"
    }
}

Nested Schema : Measure Parameters

Type: array

Title: Measure Parameters

The Measure Parameters resource manages the parameters associated with the document measures.

Show Source

• Array of: object collaborationDocumentDefinitions-measures-measureParameters-item-response

{
    "title":"Measure Parameters",
    "type":"array",
    "description":"The Measure Parameters resource manages the parameters associated with the document measures.",
    "items":{
        "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureParameters-item-response"
    }
}

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."
        }
    }
}

Nested Schema : collaborationDocumentDefinitions-measures-measureActions-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of action for a document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_ACTIONS.
• ActionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the action for a document measure.
• ActionName: string
  Name of the action for a document measure.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the measure action.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the measure action.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the measure action.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the measure action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• measureActionParticipants: array Measure Action Participants
  Title: Measure Action Participants

  The Measure Action Participants resource manages the participants associated with an action.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the measure action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the measure action.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionName":{
            "type":"string",
            "description":"Name of the action for a document measure.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the action for a document measure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the measure action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "measureActionParticipants":{
            "title":"Measure Action Participants",
            "type":"array",
            "description":"The Measure Action Participants resource manages the participants associated with an action.",
            "items":{
                "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-response"
            }
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of action for a document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_ACTIONS.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the measure action.",
            "format":"date-time",
            "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 : Measure Action Participants

Type: array

Title: Measure Action Participants

The Measure Action Participants resource manages the participants associated with an action.

Show Source

• Array of: object collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-response

{
    "title":"Measure Action Participants",
    "type":"array",
    "description":"The Measure Action Participants resource manages the participants associated with an action.",
    "items":{
        "$ref":"#/components/schemas/collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-response"
    }
}

Nested Schema : collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-response

Type: object

Show Source

• ActionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the action for a document measure.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the measure action participant.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the measure action participant.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the measure action participant.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the measure action participant.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
• ParticipantId: integer (int64)
  Read Only: true

  Value that uniquely identifies the participant for an action.
• ParticipantName: string
  Maximum Length: 255

  Name of the participant for an action.

{
    "type":"object",
    "properties":{
        "ParticipantId":{
            "type":"integer",
            "description":"Value that uniquely identifies the participant for an action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the measure action participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the measure action participant.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the action for a document measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the measure action participant.",
            "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"
            }
        },
        "ParticipantName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the participant for an action.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the measure action participant.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.",
            "nullable":false,
            "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 : collaborationDocumentDefinitions-measures-measureParameters-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the measure parameter.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the measure parameter.
• InstanceParameterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the instance of the measure parameter.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the measure parameter.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the measure parameter.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParameterCode: string
  Maximum Length: 100

  Abbreviation that identifies the parameter on the document measure.
• ParameterName: string
  Read Only: true

  Maximum Length: 80

  Name of the parameter of the document measure.
• ParameterValue: string
  Maximum Length: 255

  Value of the parameter of the document measure.
• SecondParameterValue: string
  Maximum Length: 255

  Second value of the parameter of the document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_BOUNDARY_TYPE when the ParameterCode is MEASURE_HISTORY, MEASURE_HORIZON, or LOCKED_FENCE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the measure parameter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the measure parameter.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the measure parameter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParameterValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the parameter of the document measure.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SecondParameterValue"
                ]
            },
            "x-queryable":true
        },
        "InstanceParameterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the instance of the measure parameter.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParameterName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the parameter of the document measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParameterCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that identifies the parameter on the document measure.",
            "nullable":false,
            "x-queryable":true
        },
        "SecondParameterValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Second value of the parameter of the document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_BOUNDARY_TYPE when the ParameterCode is MEASURE_HISTORY, MEASURE_HORIZON, or LOCKED_FENCE.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the measure parameter.",
            "format":"date-time",
            "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"
    }
}

Links

measureActions

Operation: /fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}/child/measures/{DocumentMeasureId}/child/measureActions

Parameters:

• DocumentId: $request.path.DocumentId
• DocumentMeasureId: $request.path.DocumentMeasureId

The Measure Actions resource manages the actions associated with a document measure.

measureParameters

Operation: /fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}/child/measures/{DocumentMeasureId}/child/measureParameters

Parameters:

• DocumentId: $request.path.DocumentId
• DocumentMeasureId: $request.path.DocumentMeasureId

The Measure Parameters resource manages the parameters associated with the document measures.

measureTypeCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/collaborationMeasureTypesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: MeasureTypeCode; Target Attribute: MeasureTypeCode
• Display Attribute: MeasureTypeCode, MeasureTypeName

Back to Top