Jump to

• Request
• Response

Get one cost scenario event

get

/fscmRestApi/resources/11.13.18.05/costScenariosV2/{ScenarioId}/child/ScenarioTimeline/{ScenarioTimelineUniqID}

Request

Path Parameters

• ScenarioId(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=
• ScenarioTimelineUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ScenarioId and ScenarioEventId ---for the Cost Scenario Events Timeline resource and used to uniquely identify an instance of Cost Scenario Events Timeline. The client should not generate the hash key value. Instead, the client should query on the Cost Scenario Events Timeline collection resource with a filter on the primary key values in order to navigate to a specific instance of Cost Scenario Events Timeline.
  
  For example: ScenarioTimeline?q=ScenarioId=<value1>;ScenarioEventId=<value2>

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: string
  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: string
  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 : costScenariosV2-ScenarioTimeline-item-response

Type: object

Show Source

• CompletedCount: integer (int32)
  Read Only: true

  Indicates the current completed count of the scenario event.
• EndTime: string (date-time)
  Read Only: true

  End time of the scenario event.
• ErrorCount: number
  Read Only: true

  Indicates the number of errors for the specific message.
• FailedCount: integer (int32)
  Read Only: true

  Indicates the current failed count of the scenario event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumEventDate: string (date-time)
  Read Only: true

  Maximum of date and time when the event occurred.
• MinimumEventDate: string (date-time)
  Read Only: true

  Minimum of date and time when the event occurred.
• ProcessId: integer (int64)
  Read Only: true

  Indicates the process identifier for the scenario event.
• ScenarioEventDate: string (date-time)
  Read Only: true

  Date and time when the event occurred.
• ScenarioEventId: integer (int64)
  Read Only: true

  Indicates the surrogate identifier generated for scenario event.
• ScenarioEventNumber: string
  Read Only: true

  Maximum Length: 30

  User-defined event number for scenario events.
• ScenarioEventType: string
  Read Only: true

  Maximum Length: 30

  Indicates the type of scenario event. Valid values are CREATE, BUILD, ROLLUP, and PUBLISH.
• ScenarioId: integer
  Read Only: true

  Indicates the unique identifier for a cost planning scenario.
• ScenarioNumber: string
  Read Only: true

  Maximum Length: 30

  Indicates the definable name that identifies a cost planning scenario.
• StartTime: string (date-time)
  Read Only: true

  Start time of the scenario event.
• Status: string
  Read Only: true

  Maximum Length: 80

  Status of the cost scenario.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Indicates the status of the scenario event. Valid values are NOT_STARTED, PROCESSING, SUCCESS, WARNING, ERROR, and CANCELED.
• Submitter: string
  Read Only: true

  Maximum Length: 1000

  Indicates the user who submitted the process.
• TimeElapsed: integer
  Read Only: true

  Indicates the time elapsed for an event.
• TotalCount: integer (int32)
  Read Only: true

  Indicates the total count of the scenario event.
• WarningCount: number
  Read Only: true

  Indicates the number of warnings for the specific message.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"Status of the cost scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WarningCount":{
            "type":"number",
            "description":"Indicates the number of warnings for the specific message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioId":{
            "type":"integer",
            "description":"Indicates the unique identifier for a cost planning scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"End time of the scenario event.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-defined event number for scenario events.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumEventDate":{
            "type":"string",
            "description":"Maximum of date and time when the event occurred.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeElapsed":{
            "type":"integer",
            "description":"Indicates the time elapsed for an event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Start time of the scenario event.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedCount":{
            "type":"integer",
            "description":"Indicates the current completed count of the scenario event.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ErrorCount":{
            "type":"number",
            "description":"Indicates the number of errors for the specific message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the scenario event. Valid values are NOT_STARTED, PROCESSING, SUCCESS, WARNING, ERROR, and CANCELED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventId":{
            "type":"integer",
            "description":"Indicates the surrogate identifier generated for scenario event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScenarioNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the definable name that identifies a cost planning scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventDate":{
            "type":"string",
            "description":"Date and time when the event occurred.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalCount":{
            "type":"integer",
            "description":"Indicates the total count of the scenario event.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Submitter":{
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the user who submitted the process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of scenario event. Valid values are CREATE, BUILD, ROLLUP, and PUBLISH.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailedCount":{
            "type":"integer",
            "description":"Indicates the current failed count of the scenario event.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MinimumEventDate":{
            "type":"string",
            "description":"Minimum of date and time when the event occurred.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Indicates the process identifier for the scenario event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Back to Top