Jump to

• Request
• Response

Get link templates

get

/rest/ofscMetadata/v1/linkTemplates

This operation retrieves a collection of link templates along with all the information about each link template.

Request

Query Parameters

• limit: integer
  The number of link template records to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is zero, greater than 100, or if no value is specified, then it defaults to 100.
• offset: integer
  The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : LinkTemplates

Type: object

The collection of link templates. It is not returned for an empty collection.

Show Source

• hasMore: boolean
  Contains one of the following values: true or false.

  If true, then there are more results that can be retrieved with successive paging requests.

  If false or if the value is not present, then there are no more results or this is the final page. The default value is true.

• items: array items
• limit: integer
  The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100.
• offset: integer
  The offset value specified in the request.
• totalResults: integer
  The total number of link templates records in the collection.

{
    "description":"The collection of link templates. It is not returned for an empty collection.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkTemplate"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of link templates records in the collection. "
        },
        "hasMore":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false.<p>If true, then there are more results that can be retrieved with successive paging requests.</p><p>If false or if the value is not present, then there are no more results or this is the final page. The default value is true.</p>"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request."
        },
        "limit":{
            "type":"integer",
            "description":"The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100."
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Link Template
  Title: Link Template

  The link template object.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkTemplate"
    }
}

Nested Schema : Link Template

Type: object

Title: Link Template

The link template object.

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false. If true, then the link template is available for creating new activity links.
• assignmentConstraint: string
  Title: Constraint for activity assignment

  The parameter specifies the constraint for assignment of the linked activities. The parameter is not applicable for the "simultaneous" link type. Available values: [ "none", "sameResource", "differentResources" ]
• label(required): string
  Title: Label

  Unique label of the link template. Use this label when adding a link to the the list of links of the "second" activity. For example, label "start_after" should appear in the list of the activity which is expected to be started after another activity. To create the link for the first activity in the pair, use the "reverseLabel" instead. This parameter is mandatory for any link template type. For the symmetrical template type ("simultaneous") it is used as the only label. Note that you cannot modify the label using API, the parameter will be ignored in update request. Maximum length is 40 characters.
• linkType(required): string
  Title: Type of the sequence constraint

  The type of the sequence constraint. This attribute can only be set when the link template is created. This attribute it is not allowed to be modified, it will be ignored in update request. Available values: [ "finishToStart", "startToStart", "simultaneous", "related" ]
• maxInterval: string
  Title: Maximum interval type

  The parameter specifies if the maximum time constraint is not used ("unlimited"), if it can or cannot be adjustable for a particular link. The parameter is not applicable for the "simultaneous" and "related" link types. Available values: [ "unlimited", "adjustable", "nonAdjustable" ]
• maxIntervalValue: integer
  Title: Maximum interval default value

  The parameter contains a predefined value of the maximum time constraint. This value is used as default for new activity links. The parameter is not applicable for the "simultaneous" and "related" link types. The paramenter is not used if maxInterval is "unlimited". Maximum allowed value is 30000.
• minInterval: string
  Title: Minimum interval type

  The parameter specifies if the minimum time constraint can or cannot be adjusted for a particular link. The parameter is not applicable for the "simultaneous" and "related" link types. Available values: [ "adjustable", "nonAdjustable" ]
• minIntervalValue: integer
  Title: Minimum interval default value

  The parameter contains a predefined value of the minimum time constraint. This value is used as default for new activity links. The parameter is not applicable for the "simultaneous" and "related" link types. Maximum allowed value is 30000
• reverseLabel: string
  Title: ReverseLabel

  Unique label of the link template. Use this label when adding a link to the the list of links of the "first" activity. For example, reverseLabel "start_before" should appear in the list of the activity which is expected to be started before another activity. The parameter is mandatory for all link template types except "simultaneous". For the "simultaneous" type it is not needed and it will be ignored in create/update requests. Note that you cannot modify the label using API, the parameter will be ignored in update request. Maximum length is 40 characters.
• schedulingConstraint: string
  Title: Constraint for activity scheduling

  The parameter specifies the constraint for scheduling the linked activities. The parameter is not applicable for the "simultaneous" link type. Available values: [ "none", "sameDay", "differentDays" ]
• translations(required): array Translations
  Title: Translations

  The list of associated names for the link as they are displayed in the activity links list. The names of a link are configured separately for the "first" activity and for the "second" activity. Note that the English tranlation is mandatory

{
    "type":"object",
    "title":"Link Template",
    "description":"The link template object.",
    "properties":{
        "label":{
            "type":"string",
            "title":"Label",
            "description":"Unique label of the link template. Use this label when adding a link to the the list of links of the \"second\" activity.\nFor example, label \"start_after\" should appear in the list of the activity which is expected to be started after another activity. To create the link for the first activity in the pair, use the \"reverseLabel\" instead.\nThis parameter is mandatory for any link template type. For the symmetrical template type (\"simultaneous\") it is used as the only label.\nNote that you cannot modify the label using API, the parameter will be ignored in update request.\nMaximum length is 40 characters."
        },
        "reverseLabel":{
            "type":"string",
            "title":"ReverseLabel",
            "description":"Unique label of the link template. Use this label when adding a link to the the list of links of the \"first\" activity.\nFor example, reverseLabel \"start_before\" should appear in the list of the activity which is expected to be started before another activity.\nThe parameter is mandatory for all link template types except \"simultaneous\". For the \"simultaneous\" type it is not needed and it will be ignored in create/update requests.\nNote that you cannot modify the label using API, the parameter will be ignored in update request.\nMaximum length is 40 characters."
        },
        "linkType":{
            "type":"string",
            "title":"Type of the sequence constraint",
            "description":"The type of the sequence constraint. This attribute can only be set when the link template is created. This attribute it is not allowed to be modified, it will be ignored in update request.\nAvailable values: [ \"finishToStart\", \"startToStart\", \"simultaneous\", \"related\" ]"
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false. If true, then the link template is available for creating new activity links."
        },
        "minInterval":{
            "type":"string",
            "title":"Minimum interval type",
            "description":"The parameter specifies if the minimum time constraint can or cannot be adjusted for a particular link.\nThe parameter is not applicable for the \"simultaneous\" and \"related\" link types.\nAvailable values: [ \"adjustable\", \"nonAdjustable\" ]"
        },
        "minIntervalValue":{
            "description":"The parameter contains a predefined value of the minimum time constraint. This value is used as default for new activity links.\nThe parameter is not applicable for the \"simultaneous\" and \"related\" link types.\nMaximum allowed value is 30000",
            "type":"integer",
            "title":"Minimum interval default value"
        },
        "maxInterval":{
            "description":"The parameter specifies if the maximum time constraint is not used (\"unlimited\"), if it can or cannot be adjustable for a particular link.\nThe parameter is not applicable for the \"simultaneous\" and \"related\" link types.\nAvailable values: [ \"unlimited\", \"adjustable\", \"nonAdjustable\" ]",
            "type":"string",
            "title":"Maximum interval type"
        },
        "maxIntervalValue":{
            "type":"integer",
            "title":"Maximum interval default value",
            "description":"The parameter contains a predefined value of the maximum time constraint. This value is used as default for new activity links.\nThe parameter is not applicable for the \"simultaneous\" and  \"related\" link types.\nThe paramenter is not used if maxInterval is \"unlimited\".\nMaximum allowed value is 30000."
        },
        "schedulingConstraint":{
            "type":"string",
            "title":"Constraint for activity scheduling",
            "description":"The parameter specifies the constraint for scheduling the linked activities.\nThe parameter is not applicable for the \"simultaneous\" link type.\nAvailable values: [ \"none\", \"sameDay\", \"differentDays\" ]"
        },
        "assignmentConstraint":{
            "type":"string",
            "title":" Constraint for activity assignment",
            "description":"The parameter specifies the constraint for assignment of the linked activities.\nThe parameter is not applicable for the \"simultaneous\" link type.\nAvailable values: [ \"none\", \"sameResource\", \"differentResources\" ]"
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TranslationLinkTemplates"
            },
            "title":"Translations",
            "description":"The list of associated names for the link as they are displayed in the activity links list. The names of a link are configured separately for the \"first\" activity and for the \"second\" activity. Note that the English tranlation is mandatory"
        }
    },
    "required":[
        "label",
        "linkType",
        "active",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The list of associated names for the link as they are displayed in the activity links list. The names of a link are configured separately for the "first" activity and for the "second" activity. Note that the English tranlation is mandatory

Show Source

• Array of: object TranslationLinkTemplates

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TranslationLinkTemplates"
    },
    "title":"Translations",
    "description":"The list of associated names for the link as they are displayed in the activity links list. The names of a link are configured separately for the \"first\" activity and for the \"second\" activity. Note that the English tranlation is mandatory"
}

Nested Schema : TranslationLinkTemplates

Type: object

Show Source

• language(required): string
  This field contains ISO code of the language (e.g. 'en-US').
• name(required): string
  Name of the link as it is displayed in the list of the "second" activity. (For the "simultaneous" link types this value is used for displaying in the lists of both activities)
• reverseName: string
  Name of the link as it is displayed in the list of the "second" activity. (For the "simultaneous" link types this value is not used)

{
    "properties":{
        "language":{
            "description":"This field contains ISO code of the language (e.g. 'en-US').",
            "type":"string"
        },
        "reverseName":{
            "description":"Name of the link as it is displayed in the list of the \"second\" activity. (For the \"simultaneous\" link types this value is not used)",
            "type":"string"
        },
        "name":{
            "description":"Name of the link as it is displayed in the list of the \"second\" activity. (For the \"simultaneous\" link types this value is used for displaying in the lists of both activities)",
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top